sphobjinv.fileops

File I/O helpers for sphobjinv.

sphobjinv is a toolkit for manipulation and inspection of Sphinx objects.inv files.

Author

Brian Skinn (bskinn@alum.mit.edu)

File Created

5 Nov 2017

Copyright

(c) Brian Skinn 2016-2020

Source Repository

https://github.com/bskinn/sphobjinv

Documentation

https://sphobjinv.readthedocs.io/en/latest

License

The MIT License; see LICENSE.txt for full license terms

Members

readbytes(path)

Read file contents and return as bytes.

Parameters

pathstr or Path – Path to file to be opened.

Returns

bbytes – Contents of the indicated file.

readjson(path)

Create dict from JSON file.

No data or schema validation is performed.

Parameters

pathstr or Path – Path to JSON file to be read.

Returns

ddict – Deserialized JSON.

urlwalk(url)

Generate a series of candidate objects.inv URLs.

URLs are based on the seed url passed in. Ensure that the path separator in url is the standard forward slash (‘/’).

Parameters

urlstr – Seed URL defining directory structure to walk through.

Yields

inv_urlstr – Candidate URL for objects.inv location.

writebytes(path, contents)

Write indicated file contents.

Any existing file at path will be overwritten.

Parameters
  • pathstr or Path – Path to file to be written.

  • contentsbytes – Content to be written to file.

writejson(path, d)

Create JSON file from dict.

No data or schema validation is performed. Any existing file at path will be overwritten.

Parameters
  • pathstr or Path – Path to output JSON file.

  • ddict – Data structure to serialize.