empty version (or project (?)) cause regex matching crash

[svenevs]

Found what I think is a bug in the header parsing. This project commented out their version number resulting in an empty Version in the header to the objects.inv:

sven:/tmp> wget https://bootstrap-datepicker.readthedocs.io/en/master/objects.inv
sven:/tmp> head -4 objects.inv 
# Sphinx inventory version 2
# Project: bootstrap-datepicker
# Version: 
# The remainder of this file is compressed using zlib.
sven:/tmp> sphobjinv convert plain objects.inv 
 

Error: Unrecognized file format

If you do it directly, you get information that seems to mean that you assume Version and Project actually have values after them (and apparently they don't need to):

>>> import sphobjinv as soi
>>> inv = soi.Inventory('objects.inv')
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<attrs generated init d264050f79466679381c6c61e7053ac5e806eac0>", line 16, in __init__
  File "/usr/local/lib/python3.6/site-packages/sphobjinv/inventory.py", line 365, in __attrs_post_init__
    self._general_import()
  File "/usr/local/lib/python3.6/site-packages/sphobjinv/inventory.py", line 598, in _general_import
    import_errors[st]):
  File "/usr/local/lib/python3.6/site-packages/sphobjinv/inventory.py", line 612, in _try_import
    p, v, o = import_fxn(src)
  File "/usr/local/lib/python3.6/site-packages/sphobjinv/inventory.py", line 659, in _import_plaintext_fname
    return self._import_plaintext_bytes(b_plain)
  File "/usr/local/lib/python3.6/site-packages/sphobjinv/inventory.py", line 629, in _import_plaintext_bytes
    b_res = pb_version.search(b_str).group(HeaderFields.Version.value)
AttributeError: 'NoneType' object has no attribute 'group'

I think you want to change .+ to be .*?

sphobjinv/sphobjinv/re.py

Line 42 in 11db748

(?P<{}>.+?) # Lazy rest of line is the project name

sphobjinv/sphobjinv/re.py

Line 51 in 11db748

(?P<{}>.+?) # Lazy rest of line is the version

And then it will return you empty strings?

[bskinn]

Never thought anybody'd build docs without a version!

You're right, that regex for version will definitely need to be changed, as you indicated -- will be interesting to see how deep into the codebase that assumption runs.

If Sphinx allows an empty project, then yeah, that'll need to be changed, too.

Thanks for reporting this! I'll get a bugfix update out as soon as I can.

[bskinn]

On a quick test, it looks like Sphinx automatically sets project = "Python" if it is not defined in conf.py. I'll make a more thorough test of Sphinx versions back through 1.0 to be sure, though. BUT, if project = "" is explicitly set in conf.py, Sphinx honors it and project indeed is null in the objects.inv

So, I think only the possibility of a blank version needs to be accounted for.

I'll have to fix both!

[svenevs]

Never thought anybody'd build docs without a version!

Hehehehe. Bugs like this are kind of fun though, I had no idea sphinx defaulted to project = "Python". Seems like you've got this under wraps, but let me know if you want any testing from me! This project has served me very well over the years 🙂

[bskinn]

This project has served me very well over the years 🙂

I haz a uzer! 😲 😃 In retrospect, I should probably have picked a name that was easier to pronounce.....

Seems like you've got this under wraps, but let me know if you want any testing from me!

Yep, the fix was pretty much as simple as you indicated, changing to .*. I added some new test inventories to the matrix (1, 2, 3) to cover, and that about did it.

Of course, updating my virtual environment to run the tests revealed that one of my other projects, which is a testing dependency of sphobjinv, is incompatible with attrs v18.2, due to some change in how attrs handles slots=True. So, I should probably cut a release of that project first, so I can better confirm dependency compatibility for v2.0.1 here.... Whee!

[bskinn]

Keep an eye out for a v2.0.1rc1 release here soon, it'll get this fix out there before I take care of the stdio-mgr problem. pip install -U --pre sphobjinv should grab it once I get it up to PyPI.

[bskinn]

v2.0.1rc1 is published, @svenevs

[bskinn]

Apologies for this fix sitting on rc1 for most of a year, @svenevs -- FYI, a final v2.0.1 is now up on PyPI.