Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Session: improvements to documentation + handle unpickleable objects #527

Open
wants to merge 33 commits into
base: master
Choose a base branch
from
Open

Session: improvements to documentation + handle unpickleable objects #527

wants to merge 33 commits into from

Commits on Jul 16, 2022

  1. code formatting changes

    @leogama
    leogama committed Jul 16, 2022
    Configuration menu
    Copy the full SHA
    ab13325 View commit details
    Browse the repository at this point in the history

  2. remove unnecessary '_main_modified' attribute from pickler

    @leogama
    leogama committed Jul 16, 2022
    Configuration menu
    Copy the full SHA
    33ca2ed View commit details
    Browse the repository at this point in the history

  3. new _open() function to handle file names and file-like objects

    @leogama
    leogama committed Jul 16, 2022
    Configuration menu
    Copy the full SHA
    ad8db21 View commit details
    Browse the repository at this point in the history

  4. merge function _make_peekable() with _open()

    @leogama
    leogama committed Jul 16, 2022
    Configuration menu
    Copy the full SHA
    da4cc07 View commit details
    Browse the repository at this point in the history

  5. new function is_module_pickle()

    @leogama
    leogama committed Jul 16, 2022
    Configuration menu
    Copy the full SHA
    1732e3d View commit details
    Browse the repository at this point in the history

  6. move session-related code to session.py submodule

    @leogama
    leogama committed Jul 16, 2022
    Configuration menu
    Copy the full SHA
    2fdd31d View commit details
    Browse the repository at this point in the history

Commits on Jul 19, 2022

  1. session: deal with modules with unpickleable objects

    @leogama
    leogama committed Jul 19, 2022
    Configuration menu
    Copy the full SHA
    6b55755 View commit details
    Browse the repository at this point in the history

  2. disable framing when using the 'refonfail' option

    @leogama
    leogama committed Jul 19, 2022
    Configuration menu
    Copy the full SHA
    aac47b5 View commit details
    Browse the repository at this point in the history

Commits on Jul 21, 2022

  1. rename is_module_pickle() to is_pickled_module(); fix _dill's __all__

    @leogama
    leogama committed Jul 21, 2022
    Configuration menu
    Copy the full SHA
    5e4d912 View commit details
    Browse the repository at this point in the history

Commits on Jul 22, 2022

  1. sync with branch 'session-excludes'

    @leogama
    leogama committed Jul 22, 2022
    Configuration menu
    Copy the full SHA
    699f30a View commit details
    Browse the repository at this point in the history

  2. refonfail: save modules by reference using save_reduce()

    @leogama
    leogama committed Jul 22, 2022
    Configuration menu
    Copy the full SHA
    04968f3 View commit details
    Browse the repository at this point in the history

  3. unpickleable ctypes objects raise ValueError...

    @leogama
    leogama committed Jul 22, 2022
    Configuration menu
    Copy the full SHA
    a596126 View commit details
    Browse the repository at this point in the history

Commits on Jul 23, 2022

  1. Merge branch 'master' into document-session

    @leogama
    leogama committed Jul 23, 2022
    Configuration menu
    Copy the full SHA
    d3837cf View commit details
    Browse the repository at this point in the history

Commits on Jul 24, 2022

  1. move common autodoc options to conf.py and exclude some special members 

    Exclude special class members that are implementation details and give
practically no useful information:

- __dict__ (can generate really big strings)
- __module__
- __slots__
- __weakref__
    @leogama
    leogama committed Jul 24, 2022
    Configuration menu
    Copy the full SHA
    f46d399 View commit details
    Browse the repository at this point in the history

  2. don't document trace() twice

    @leogama
    leogama committed Jul 24, 2022
    Configuration menu
    Copy the full SHA
    bef5795 View commit details
    Browse the repository at this point in the history

Commits on Jul 26, 2022

  1. fix is_pickled_module()

    @leogama
    leogama committed Jul 26, 2022
    Configuration menu
    Copy the full SHA
    953b5e0 View commit details
    Browse the repository at this point in the history

Commits on Jul 30, 2022

  1. deteail the effects of 'module' argument in load_module() and rename … 

    …'main' to 'module' on doctstrings
    @leogama
    leogama committed Jul 30, 2022
    Configuration menu
    Copy the full SHA
    e5da1c8 View commit details
    Browse the repository at this point in the history

  2. Better describe the side effects and the usage of the returned value … 

    …from load_module()
    @leogama
    leogama committed Jul 30, 2022
    Configuration menu
    Copy the full SHA
    2e4887c View commit details
    Browse the repository at this point in the history

  3. describe session module behavior and use cases

    @leogama
    leogama committed Jul 30, 2022
    Configuration menu
    Copy the full SHA
    be319c8 View commit details
    Browse the repository at this point in the history

Commits on Aug 1, 2022

  1. add Python License and copyright notice for modified code as specifie… 

    …d by the licensce
    @leogama
    leogama committed Aug 1, 2022
    Configuration menu
    Copy the full SHA
    a9ea883 View commit details
    Browse the repository at this point in the history

Commits on Aug 2, 2022

  1. revert addition of PSF license; add link to license

    @leogama
    leogama committed Aug 2, 2022
    Configuration menu
    Copy the full SHA
    b722431 View commit details
    Browse the repository at this point in the history

Commits on Aug 3, 2022

  1. _open(): cover all the possible file opening modes

    @leogama
    leogama committed Aug 3, 2022
    Configuration menu
    Copy the full SHA
    2a7e984 View commit details
    Browse the repository at this point in the history

  2. grammar

    @leogama
    leogama committed Aug 3, 2022
    Configuration menu
    Copy the full SHA
    fa4fa85 View commit details
    Browse the repository at this point in the history

  3. better document Pickler.save() and Pickler._save_module_dict()

    @leogama
    leogama committed Aug 3, 2022
    Configuration menu
    Copy the full SHA
    92318a7 View commit details
    Browse the repository at this point in the history

Commits on Aug 4, 2022

  1. Merge branch 'master' into document-session

    @leogama
    leogama committed Aug 4, 2022
    Configuration menu
    Copy the full SHA
    4fc2f5f View commit details
    Browse the repository at this point in the history

  2. move session settings to session.py; changes to refonfail

    @leogama
    leogama committed Aug 4, 2022
    Configuration menu
    Copy the full SHA
    0e365f5 View commit details
    Browse the repository at this point in the history

  3. add _TruncatableWriter to handle 'refonfail' with non-seekable streams

    @leogama
    leogama committed Aug 4, 2022
    Configuration menu
    Copy the full SHA
    9c54e34 View commit details
    Browse the repository at this point in the history

  4. update 'refonfail' example

    @leogama
    leogama committed Aug 4, 2022
    Configuration menu
    Copy the full SHA
    ffdd180 View commit details
    Browse the repository at this point in the history

Commits on Aug 13, 2022

  1. Merge branch 'master' into document-session

    @leogama
    leogama committed Aug 13, 2022
    Configuration menu
    Copy the full SHA
    d5b1701 View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2022

  1. merge the two save() methods and save_module_dict() with _save_module… 

    …_dict()
    @leogama
    leogama committed Aug 14, 2022
    Configuration menu
    Copy the full SHA
    f60d239 View commit details
    Browse the repository at this point in the history

  2. minor

    @leogama
    leogama committed Aug 14, 2022
    Configuration menu
    Copy the full SHA
    4fe577b View commit details
    Browse the repository at this point in the history

  3. grammar; keep __weakref__ attribute in docs

    @leogama
    leogama committed Aug 14, 2022
    Configuration menu
    Copy the full SHA
    d059d84 View commit details
    Browse the repository at this point in the history

Commits on Oct 4, 2022

  1. Add option 'refonfail' for dump_module (enabled by default) 

    Other relevant changes in this commit:

- Complement and improve the documentation of _dill.py and session.py
- Rename the submodule 'logger' back to 'logging'.
- Now, the submodule 'logging' is meant to be used also as a proxy to the StdLib module of the same name.
- The level for pickling tracing is now 'logging.TRACE', a custom level between INFO and DEBUG
- New: if logging level is set to INFO or lower, the variables saved by reference, either by
  'refimported' or by 'refonfail', are listed.
- New internal functions: _is_imported_module(), _is_stdlib_module() and _module_package()
- New private submodule '_utils': new helper _open() context manager for opening streams
- More tests added to test_session.py
- Etc.
    @leogama
    leogama committed Oct 4, 2022
    Configuration menu
    Copy the full SHA
    8bf6157 View commit details
    Browse the repository at this point in the history