Full module, all documentation, unittests, config files, etc

4 years ago · bfee6e6b57
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1,178 @@
 ####### MacOS Start #######
 # General
 .DS_Store
 .AppleDouble
 .LSOverride

 # Icon must end with two \r
 Icon


 # Thumbnails
 ._*

 # Files that might appear in the root of a volume
 .DocumentRevisions-V100
 .fseventsd
 .Spotlight-V100
 .TemporaryItems
 .Trashes
 .VolumeIcon.icns
 .com.apple.timemachine.donotpresent

 # Directories potentially created on remote AFP share
 .AppleDB
 .AppleDesktop
 Network Trash Folder
 Temporary Items
 .apdisk
 ####### MacOS End #######

 ####### Windows Start #######
 # Windows thumbnail cache files
 Thumbs.db
 ehthumbs.db
 ehthumbs_vista.db

 # Dump file
 *.stackdump

 # Folder config file
 [Dd]esktop.ini

 # Recycle Bin used on file shares
 $RECYCLE.BIN/

 # Windows Installer files
 *.cab
 *.msi
 *.msix
 *.msm
 *.msp

 # Windows shortcuts
 *.lnk
 ####### Windows End #######

 ####### Python Start #######
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
 *$py.class

 # C extensions
 *.so

 # Distribution / packaging
 .Python
 build/
 develop-eggs/
 dist/
 downloads/
 eggs/
 .eggs/
 lib/
 lib64/
 parts/
 sdist/
 var/
 wheels/
 *.egg-info/
 .installed.cfg
 *.egg
 MANIFEST

 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
 *.manifest
 *.spec

 # Installer logs
 pip-log.txt
 pip-delete-this-directory.txt
 pip-selfcheck.json

 # Unit test / coverage reports
 htmlcov/
 .tox/
 .nox/
 .coverage
 .coverage.*
 docs/source/coverage/*
 !docs/source/coverage/extract_source.py
 docs/source/api/*
 .cache
 nosetests.xml
 coverage.xml
 *.cover
 .hypothesis/
 .pytest_cache/
 .pylint.d/

 # Translations
 *.mo
 *.pot

 # Django stuff:
 *.log
 local_settings.py
 db.sqlite3
 static/*
 !static/.touch

 # Flask stuff:
 instance/
 .webassets-cache

 # Scrapy stuff:
 .scrapy

 # Sphinx documentation
 docs/_build/
 docs/build/

 # PyBuilder
 target/

 # Jupyter Notebook
 .ipynb_checkpoints

 # IPython
 profile_default/
 ipython_config.py

 # pyenv
 .python-version

 # celery beat schedule file
 celerybeat-schedule

 # SageMath parsed files
 *.sage.py

 # Environments
 .env
 .envrc
 .venv
 env/
 venv/
 ENV/
 env.bak/
 venv.bak/

 # Spyder project settings
 .spyderproject
 .spyproject

 # Rope project settings
 .ropeproject

 # mkdocs documentation
 /site

 # mypy
 .mypy_cache/
 .dmypy.json
 dmypy.json
 ####### Python End #######
--- a/.isort.cfg
+++ b/.isort.cfg
@@ -0,0 +1,15 @@
 [settings]
 line_length = 88
 known_first_party = shm_dict
 known_third_party = arrow
                    posix_ipc
                    requests
                    six
                    ujson
                    urllib3
 multi_line_output = 3
 # length_sort = 1
 # balanced_wrapping = True
 force_grid_wrap = 0
 include_trailing_comma = True
 use_parentheses = True
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,58 @@
 exclude: '^$'
 fail_fast: false
 default_language_version:
  python: python3.7
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v2.0.0
  hooks:
  - id: check-added-large-files
  - id: check-ast
    types: [file, python]
  - id: check-case-conflict
  - id: check-json
    types: [file, json]
  - id: check-merge-conflict
  - id: check-symlinks
    types: [symlink]
  - id: check-yaml
    args: [--allow-multiple-documents]
    types: [file, yaml]
  - id: detect-private-key
    types: [file, text]
  - id: end-of-file-fixer
    types: [file, python]
  - id: fix-encoding-pragma
    types: [file, python]
  - id: requirements-txt-fixer
    types: [file, text]
  - id: trailing-whitespace
    args: [--markdown-linebreak-ext=md]
    types: [file, text]
    exclude: ^docs/.*/coverage/.*\.html$
 - repo: https://github.com/pre-commit/mirrors-isort
  rev: v4.3.4
  hooks:
  - id: isort
    types: [file, python]
 - repo: https://github.com/ambv/black
  rev: stable
  hooks:
  - id: black
    language_version: python3.7
 - repo: https://github.com/pre-commit/pre-commit-hooks
  rev: v2.0.0
  hooks:
  - id: flake8
    exclude: ^setup.py$
    types: [file, python]
 - repo: local
  hooks:
  - id: check-manifest
    name: Check Manifest
    description: Check package manifest against git committed files.
    always_run: true
    files: '^$'
    entry: check-manifest
    language: python
    types: [file, plain-text]
--- a/.pylintrc
+++ b/.pylintrc
@@ -0,0 +1,568 @@
 [MASTER]

 # A comma-separated list of package or module names from where C extensions may
 # be loaded. Extensions are loading into the active Python interpreter and may
 # run arbitrary code.
 extension-pkg-whitelist=

 # Add files or directories to the blacklist. They should be base names, not
 # paths.
 ignore=CVS

 # Add files or directories matching the regex patterns to the blacklist. The
 # regex matches against base names, not paths.
 ignore-patterns=.tox,
                site-packages,
                _version.py

 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
 #init-hook="from pylint.config import find_pylintrc; import os, sys; sys.path.append(os.path.dirname(find_pylintrc()))"

 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
 # number of processors available to use.
 jobs=0

 # Control the amount of potential inferred values when inferring a single
 # object. This can help the performance when dealing with large functions or
 # complex, nested conditions.
 limit-inference-results=100

 # List of plugins (as comma separated values of python modules names) to load,
 # usually to register additional checkers.
 load-plugins=

 # Pickle collected data for later comparisons.
 persistent=yes

 # Specify a configuration file.
 #rcfile=

 # When enabled, pylint would attempt to guess common misconfiguration and emit
 # user-friendly hints instead of false-positive error messages.
 suggestion-mode=yes

 # Allow loading of arbitrary C extensions. Extensions are imported into the
 # active Python interpreter and may run arbitrary code.
 unsafe-load-any-extension=no


 [MESSAGES CONTROL]

 # Only show warnings with the listed confidence levels. Leave empty to show
 # all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED.
 confidence=

 # Disable the message, report, category or checker with the given id(s). You
 # can either give multiple identifiers separated by comma (,) or put this
 # option multiple times (only on the command line, not in the configuration
 # file where it should appear only once). You can also use "--disable=all" to
 # disable everything first and then reenable specific checks. For example, if
 # you want to run only the similarities checker, you can use "--disable=all
 # --enable=similarities". If you want to run only the classes checker, but have
 # no Warning level messages displayed, use "--disable=all --enable=classes
 # --disable=W".
 disable=print-statement,
        parameter-unpacking,
        unpacking-in-except,
        old-raise-syntax,
        backtick,
        long-suffix,
        old-ne-operator,
        old-octal-literal,
        import-star-module-level,
        non-ascii-bytes-literal,
        raw-checker-failed,
        bad-inline-option,
        locally-disabled,
        locally-enabled,
        file-ignored,
        suppressed-message,
        useless-suppression,
        deprecated-pragma,
        use-symbolic-message-instead,
        apply-builtin,
        basestring-builtin,
        buffer-builtin,
        cmp-builtin,
        coerce-builtin,
        execfile-builtin,
        file-builtin,
        long-builtin,
        raw_input-builtin,
        reduce-builtin,
        standarderror-builtin,
        unicode-builtin,
        xrange-builtin,
        coerce-method,
        delslice-method,
        getslice-method,
        setslice-method,
        no-absolute-import,
        old-division,
        dict-iter-method,
        dict-view-method,
        next-method-called,
        metaclass-assignment,
        indexing-exception,
        raising-string,
        reload-builtin,
        oct-method,
        hex-method,
        nonzero-method,
        cmp-method,
        input-builtin,
        round-builtin,
        intern-builtin,
        unichr-builtin,
        map-builtin-not-iterating,
        zip-builtin-not-iterating,
        range-builtin-not-iterating,
        filter-builtin-not-iterating,
        using-cmp-argument,
        eq-without-hash,
        div-method,
        idiv-method,
        rdiv-method,
        exception-message-attribute,
        invalid-str-codec,
        sys-max-int,
        bad-python3-import,
        deprecated-string-function,
        deprecated-str-translate-call,
        deprecated-itertools-function,
        deprecated-types-field,
        next-method-defined,
        dict-items-not-iterating,
        dict-keys-not-iterating,
        dict-values-not-iterating,
        deprecated-operator-function,
        deprecated-urllib-function,
        xreadlines-attribute,
        deprecated-sys-function,
        exception-escape,
        comprehension-escape,
        missing-docstring,
        duplicate-code,
        import-error,
        old-style-class,
        ungrouped-imports,
        bad-continuation,
        useless-object-inheritance

 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option
 # multiple time (only on the command line, not in the configuration file where
 # it should appear only once). See also the "--disable" option for examples.
 enable=c-extension-no-member


 [REPORTS]

 # Python expression which should return a note less than 10 (10 is the highest
 # note). You have access to the variables errors warning, statement which
 # respectively contain the number of errors / warnings messages and the total
 # number of statements analyzed. This is used by the global evaluation report
 # (RP0004).
 evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10)

 # Template used to display messages. This is a python new-style format string
 # used to format the message information. See doc for all details.
 msg-template='{path}:{obj}:{line}: [{msg_id}({symbol})] {msg}'

 # Set the output format. Available formats are text, parseable, colorized, json
 # and msvs (visual studio). You can also give a reporter class, e.g.
 # mypackage.mymodule.MyReporterClass.
 output-format=text

 # Tells whether to display a full report or only the messages.
 reports=no

 # Activate the evaluation score.
 score=yes


 [REFACTORING]

 # Maximum number of nested blocks for function / method body
 max-nested-blocks=5

 # Complete name of functions that never returns. When checking for
 # inconsistent-return-statements if a never returning function is called then
 # it will be considered as an explicit return statement and no message will be
 # printed.
 never-returning-functions=sys.exit


 [BASIC]

 # Naming style matching correct argument names.
 argument-naming-style=snake_case

 # Regular expression matching correct argument names. Overrides argument-
 # naming-style.
 #argument-rgx=

 # Naming style matching correct attribute names.
 attr-naming-style=snake_case

 # Regular expression matching correct attribute names. Overrides attr-naming-
 # style.
 #attr-rgx=

 # Bad variable names which should always be refused, separated by a comma.
 bad-names=foo,
          bar,
          baz,
          toto,
          tutu,
          tata

 # Naming style matching correct class attribute names.
 class-attribute-naming-style=any

 # Regular expression matching correct class attribute names. Overrides class-
 # attribute-naming-style.
 #class-attribute-rgx=

 # Naming style matching correct class names.
 class-naming-style=PascalCase

 # Regular expression matching correct class names. Overrides class-naming-
 # style.
 #class-rgx=

 # Naming style matching correct constant names.
 const-naming-style=UPPER_CASE

 # Regular expression matching correct constant names. Overrides const-naming-
 # style.
 #const-rgx=

 # Minimum line length for functions/classes that require docstrings, shorter
 # ones are exempt.
 docstring-min-length=-1

 # Naming style matching correct function names.
 function-naming-style=snake_case

 # Regular expression matching correct function names. Overrides function-
 # naming-style.
 #function-rgx=

 # Good variable names which should always be accepted, separated by a comma.
 good-names=e,
           i,
           j,
           k,
           ex,
           Run,
           _

 # Include a hint for the correct naming format with invalid-name.
 include-naming-hint=no

 # Naming style matching correct inline iteration names.
 inlinevar-naming-style=any

 # Regular expression matching correct inline iteration names. Overrides
 # inlinevar-naming-style.
 #inlinevar-rgx=

 # Naming style matching correct method names.
 method-naming-style=snake_case

 # Regular expression matching correct method names. Overrides method-naming-
 # style.
 #method-rgx=

 # Naming style matching correct module names.
 module-naming-style=snake_case

 # Regular expression matching correct module names. Overrides module-naming-
 # style.
 #module-rgx=

 # Colon-delimited sets of names that determine each other's naming style when
 # the name regexes allow several styles.
 name-group=

 # Regular expression which should only match function or class names that do
 # not require a docstring.
 no-docstring-rgx=^_

 # List of decorators that produce properties, such as abc.abstractproperty. Add
 # to this list to register other decorators that produce valid properties.
 # These decorators are taken in consideration only for invalid-name.
 property-classes=abc.abstractproperty

 # Naming style matching correct variable names.
 variable-naming-style=snake_case

 # Regular expression matching correct variable names. Overrides variable-
 # naming-style.
 #variable-rgx=


 [FORMAT]

 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
 expected-line-ending-format=

 # Regexp for a line that is allowed to be longer than the limit.
 ignore-long-lines=^\s*(# )?<?https?://\S+>?$

 # Number of spaces of indent required inside a hanging  or continued line.
 indent-after-paren=4

 # String used as indentation unit. This is usually "    " (4 spaces) or "\t" (1
 # tab).
 indent-string='    '

 # Maximum number of characters on a single line.
 max-line-length=100

 # Maximum number of lines in a module.
 max-module-lines=3000

 # List of optional constructs for which whitespace checking is disabled. `dict-
 # separator` is used to allow tabulation in dicts, etc.: {1  : 1,\n222: 2}.
 # `trailing-comma` allows a space between comma and closing bracket: (a, ).
 # `empty-line` allows space-only lines.
 no-space-check=trailing-comma,
               dict-separator

 # Allow the body of a class to be on the same line as the declaration if body
 # contains single statement.
 single-line-class-stmt=no

 # Allow the body of an if to be on the same line as the test if there is no
 # else.
 single-line-if-stmt=no


 [LOGGING]

 # Logging modules to check that the string format arguments are in logging
 # function parameter format.
 logging-modules=logging


 [MISCELLANEOUS]

 # List of note tags to take in consideration, separated by a comma.
 notes=FIXME,
      XXX,
      TODO


 [SIMILARITIES]

 # Ignore comments when computing similarities.
 ignore-comments=yes

 # Ignore docstrings when computing similarities.
 ignore-docstrings=yes

 # Ignore imports when computing similarities.
 ignore-imports=no

 # Minimum lines number of a similarity.
 min-similarity-lines=4


 [SPELLING]

 # Limits count of emitted suggestions for spelling mistakes.
 max-spelling-suggestions=4

 # Spelling dictionary name. Available dictionaries: none. To make it working
 # install python-enchant package..
 spelling-dict=

 # List of comma separated words that should not be checked.
 spelling-ignore-words=

 # A path to a file that contains private dictionary; one word per line.
 spelling-private-dict-file=

 # Tells whether to store unknown words to indicated private dictionary in
 # --spelling-private-dict-file option instead of raising a message.
 spelling-store-unknown-words=no


 [TYPECHECK]

 # List of decorators that produce context managers, such as
 # contextlib.contextmanager. Add to this list to register other decorators that
 # produce valid context managers.
 contextmanager-decorators=contextlib.contextmanager

 # List of members which are set dynamically and missed by pylint inference
 # system, and so shouldn't trigger E1101 when accessed. Python regular
 # expressions are accepted.
 generated-members=

 # Tells whether missing members accessed in mixin class should be ignored. A
 # mixin class is detected if its name ends with "mixin" (case insensitive).
 ignore-mixin-members=yes

 # Tells whether to warn about missing members when the owner of the attribute
 # is inferred to be None.
 ignore-none=yes

 # This flag controls whether pylint should warn about no-member and similar
 # checks whenever an opaque object is returned when inferring. The inference
 # can return multiple potential results while evaluating a Python object, but
 # some branches might not be evaluated, which results in partial inference. In
 # that case, it might be useful to still emit no-member and other checks for
 # the rest of the inferred objects.
 ignore-on-opaque-inference=yes

 # List of class names for which member attributes should not be checked (useful
 # for classes with dynamically set attributes). This supports the use of
 # qualified names.
 ignored-classes=optparse.Values,thread._local,_thread._local

 # List of module names for which member attributes should not be checked
 # (useful for modules/projects where namespaces are manipulated during runtime
 # and thus existing member attributes cannot be deduced by static analysis. It
 # supports qualified module names, as well as Unix pattern matching.
 ignored-modules=

 # Show a hint with possible names when a member name was not found. The aspect
 # of finding the hint is based on edit distance.
 missing-member-hint=yes

 # The minimum edit distance a name should have in order to be considered a
 # similar match for a missing member name.
 missing-member-hint-distance=1

 # The total number of similar names that should be taken in consideration when
 # showing a hint for a missing member.
 missing-member-max-choices=1


 [VARIABLES]

 # List of additional names supposed to be defined in builtins. Remember that
 # you should avoid to define new builtins when possible.
 additional-builtins=

 # Tells whether unused global variables should be treated as a violation.
 allow-global-unused-variables=yes

 # List of strings which can identify a callback function by name. A callback
 # name must start or end with one of those strings.
 callbacks=cb_,
          _cb

 # A regular expression matching the name of dummy variables (i.e. expected to
 # not be used).
 dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_

 # Argument names that match this expression will be ignored. Default to name
 # with leading underscore.
 ignored-argument-names=_.*|^ignored_|^unused_

 # Tells whether we should check for unused import in __init__ files.
 init-import=no

 # List of qualified module names which can have objects that can redefine
 # builtins.
 redefining-builtins-modules=six.moves,past.builtins,future.builtins,builtins,io


 [CLASSES]

 # List of method names used to declare (i.e. assign) instance attributes.
 defining-attr-methods=__init__,
                      __new__,
                      setUp

 # List of member names, which should be excluded from the protected access
 # warning.
 exclude-protected=_asdict,
                  _fields,
                  _replace,
                  _source,
                  _make

 # List of valid names for the first argument in a class method.
 valid-classmethod-first-arg=cls

 # List of valid names for the first argument in a metaclass class method.
 valid-metaclass-classmethod-first-arg=cls


 [DESIGN]

 # Maximum number of arguments for function / method.
 max-args=15

 # Maximum number of attributes for a class (see R0902).
 max-attributes=20

 # Maximum number of boolean expressions in an if statement.
 max-bool-expr=7

 # Maximum number of branch for function / method body.
 max-branches=12

 # Maximum number of locals for function / method body.
 max-locals=15

 # Maximum number of parents for a class (see R0901).
 max-parents=7

 # Maximum number of public methods for a class (see R0904).
 max-public-methods=20

 # Maximum number of return / yield for function / method body.
 max-returns=10

 # Maximum number of statements in function / method body.
 max-statements=50

 # Minimum number of public methods for a class (see R0903).
 min-public-methods=2


 [IMPORTS]

 # Allow wildcard imports from modules that define __all__.
 allow-wildcard-with-all=no

 # Analyse import fallback blocks. This can be used to support both Python 2 and
 # 3 compatible code, which means that the block might have code that exists
 # only in one or another interpreter, leading to false positives when analysed.
 analyse-fallback-blocks=no

 # Deprecated modules which should not be used, separated by a comma.
 deprecated-modules=optparse,tkinter.tix

 # Create a graph of external dependencies in the given file (report RP0402 must
 # not be disabled).
 ext-import-graph=

 # Create a graph of every (i.e. internal and external) dependencies in the
 # given file (report RP0402 must not be disabled).
 import-graph=

 # Create a graph of internal dependencies in the given file (report RP0402 must
 # not be disabled).
 int-import-graph=

 # Force import order to recognize a module as part of the standard
 # compatibility libraries.
 known-standard-library=

 # Force import order to recognize a module as part of a third party library.
 known-third-party=enchant


 [EXCEPTIONS]

 # Exceptions that will emit a warning when being caught. Defaults to
 # "Exception".
 overgeneral-exceptions=Exception
--- a/LICENSE
+++ b/LICENSE
@@ -1,70 +1,226 @@
 GNU LESSER GENERAL PUBLIC LICENSE 

 GNU GENERAL PUBLIC LICENSE

 Version 3, 29 June 2007
 Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>

 Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>

 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
 Preamble

 The GNU General Public License is a free, copyleft license for software and other kinds of works.

 The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.

 When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.

 To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.

 For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.

 Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.

 For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.

 Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.

 Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.

 The precise terms and conditions for copying, distribution and modification follow.
 TERMS AND CONDITIONS
 0. Definitions.

 “This License” refers to version 3 of the GNU General Public License.

 “Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.

 “The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.

 To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.

 A “covered work” means either the unmodified Program or a work based on the Program.

 To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.

 To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.

 An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
 1. Source Code.

 The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.

 A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.

 The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.

 The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.

 The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.

 The Corresponding Source for a work in source code form is that same work.
 2. Basic Permissions.

 All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.

 You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.

 Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
 3. Protecting Users' Legal Rights From Anti-Circumvention Law.

 No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.

 When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
 4. Conveying Verbatim Copies.

 You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.

 You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
 5. Conveying Modified Source Versions.

 You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
    b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
    c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
    d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.

 A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
 6. Conveying Non-Source Forms.

 You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:

    a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
    b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
    c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
    d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
    e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.

 A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.

 A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.

 “Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.

 If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).

 The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.

 Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
 7. Additional Terms.

 “Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.

 When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.

 Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
    b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
    c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
    d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
    e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
    f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.

 All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.

 If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.

 Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
 8. Termination.

 You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).

 However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

 Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

 Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
 9. Acceptance Not Required for Having Copies.

 You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
 10. Automatic Licensing of Downstream Recipients.

 Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.

 An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.

 You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
 11. Patents.

 A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.

 This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
 A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.

 0. Additional Definitions.
 Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.

 As used herein, "this License" refers to version 3 of the GNU Lesser General Public License, and the "GNU GPL" refers to version 3 of the GNU General Public License.
 In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.

 "The Library" refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.
 If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.

 An "Application" is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.
 If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.

 A "Combined Work" is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the "Linked Version".
 A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.

 The "Minimal Corresponding Source" for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.
 Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
 12. No Surrender of Others' Freedom.

 The "Corresponding Application Code" for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
 If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
 13. Use with the GNU Affero General Public License.

 1. Exception to Section 3 of the GNU GPL. 
 You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
 Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
 14. Revised Versions of this License.

 2. Conveying Modified Versions. 
 If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:
 The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

 a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
 Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.

 b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.
 If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.

 3. Object Code Incorporating Material from Library Header Files. 
 The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:
 Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
 15. Disclaimer of Warranty.

 a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
 THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
 16. Limitation of Liability.

 b) Accompany the object code with a copy of the GNU GPL and this license document.
 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 17. Interpretation of Sections 15 and 16.

 4. Combined Works. 
 You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:
 If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.

 a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
 END OF TERMS AND CONDITIONS
 How to Apply These Terms to Your New Programs

 b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
 If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.

 c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
 To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.

 d) Do one of the following:
    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

 0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

 1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

 e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)
    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

 5. Combined Libraries. 
 You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:
 Also add information on how to contact you by electronic and paper mail.

 a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
 If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:

 b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.
    <program>  Copyright (C) <year>  <name of author>
    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
    This is free software, and you are welcome to redistribute it
    under certain conditions; type `show c' for details.

 6. Revised Versions of the GNU Lesser General Public License. 
 The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
 The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an “about box”.

 Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.
 You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see <https://www.gnu.org/licenses/>.

 If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall 
 apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
 The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read <https://www.gnu.org/licenses/why-not-lgpl.html>.
--- a/LICENSE.LESSER
+++ b/LICENSE.LESSER
@@ -0,0 +1,66 @@

 GNU LESSER GENERAL PUBLIC LICENSE

 Version 3, 29 June 2007

 Copyright © 2007 Free Software Foundation, Inc. <https://fsf.org/>

 Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

 This version of the GNU Lesser General Public License incorporates the terms and conditions of version 3 of the GNU General Public License, supplemented by the additional permissions listed below.
 0. Additional Definitions.

 As used herein, “this License” refers to version 3 of the GNU Lesser General Public License, and the “GNU GPL” refers to version 3 of the GNU General Public License.

 “The Library” refers to a covered work governed by this License, other than an Application or a Combined Work as defined below.

 An “Application” is any work that makes use of an interface provided by the Library, but which is not otherwise based on the Library. Defining a subclass of a class defined by the Library is deemed a mode of using an interface provided by the Library.

 A “Combined Work” is a work produced by combining or linking an Application with the Library. The particular version of the Library with which the Combined Work was made is also called the “Linked Version”.

 The “Minimal Corresponding Source” for a Combined Work means the Corresponding Source for the Combined Work, excluding any source code for portions of the Combined Work that, considered in isolation, are based on the Application, and not on the Linked Version.

 The “Corresponding Application Code” for a Combined Work means the object code and/or source code for the Application, including any data and utility programs needed for reproducing the Combined Work from the Application, but excluding the System Libraries of the Combined Work.
 1. Exception to Section 3 of the GNU GPL.

 You may convey a covered work under sections 3 and 4 of this License without being bound by section 3 of the GNU GPL.
 2. Conveying Modified Versions.

 If you modify a copy of the Library, and, in your modifications, a facility refers to a function or data to be supplied by an Application that uses the facility (other than as an argument passed when the facility is invoked), then you may convey a copy of the modified version:

    a) under this License, provided that you make a good faith effort to ensure that, in the event an Application does not supply the function or data, the facility still operates, and performs whatever part of its purpose remains meaningful, or
    b) under the GNU GPL, with none of the additional permissions of this License applicable to that copy.

 3. Object Code Incorporating Material from Library Header Files.

 The object code form of an Application may incorporate material from a header file that is part of the Library. You may convey such object code under terms of your choice, provided that, if the incorporated material is not limited to numerical parameters, data structure layouts and accessors, or small macros, inline functions and templates (ten or fewer lines in length), you do both of the following:

    a) Give prominent notice with each copy of the object code that the Library is used in it and that the Library and its use are covered by this License.
    b) Accompany the object code with a copy of the GNU GPL and this license document.

 4. Combined Works.

 You may convey a Combined Work under terms of your choice that, taken together, effectively do not restrict modification of the portions of the Library contained in the Combined Work and reverse engineering for debugging such modifications, if you also do each of the following:

    a) Give prominent notice with each copy of the Combined Work that the Library is used in it and that the Library and its use are covered by this License.
    b) Accompany the Combined Work with a copy of the GNU GPL and this license document.
    c) For a Combined Work that displays copyright notices during execution, include the copyright notice for the Library among these notices, as well as a reference directing the user to the copies of the GNU GPL and this license document.
    d) Do one of the following:
        0) Convey the Minimal Corresponding Source under the terms of this License, and the Corresponding Application Code in a form suitable for, and under terms that permit, the user to recombine or relink the Application with a modified version of the Linked Version to produce a modified Combined Work, in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.
        1) Use a suitable shared library mechanism for linking with the Library. A suitable mechanism is one that (a) uses at run time a copy of the Library already present on the user's computer system, and (b) will operate properly with a modified version of the Library that is interface-compatible with the Linked Version.
    e) Provide Installation Information, but only if you would otherwise be required to provide such information under section 6 of the GNU GPL, and only to the extent that such information is necessary to install and execute a modified version of the Combined Work produced by recombining or relinking the Application with a modified version of the Linked Version. (If you use option 4d0, the Installation Information must accompany the Minimal Corresponding Source and Corresponding Application Code. If you use option 4d1, you must provide the Installation Information in the manner specified by section 6 of the GNU GPL for conveying Corresponding Source.)

 5. Combined Libraries.

 You may place library facilities that are a work based on the Library side by side in a single library together with other library facilities that are not Applications and are not covered by this License, and convey such a combined library under terms of your choice, if you do both of the following:

    a) Accompany the combined library with a copy of the same work based on the Library, uncombined with any other library facilities, conveyed under the terms of this License.
    b) Give prominent notice with the combined library that part of it is a work based on the Library, and explaining where to find the accompanying uncombined form of the same work.

 6. Revised Versions of the GNU Lesser General Public License.

 The Free Software Foundation may publish revised and/or new versions of the GNU Lesser General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.

 Each version is given a distinguishing version number. If the Library as you received it specifies that a certain numbered version of the GNU Lesser General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that published version or of any later version published by the Free Software Foundation. If the Library as you received it does not specify a version number of the GNU Lesser General Public License, you may choose any version of the GNU Lesser General Public License ever published by the Free Software Foundation.

 If the Library as you received it specifies that a proxy can decide whether future versions of the GNU Lesser General Public License shall apply, that proxy's public statement of acceptance of any version is permanent authorization for you to choose that version for the Library.
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -0,0 +1,19 @@
 include *.md
 include .isort.cfg
 include .pre-commit-config.yaml
 include .pylintrc
 include LICENSE
 include LICENSE.LESSER
 include pyproject.toml
 include requirements*
 include tox.ini
 include docker/Dockerfile
 include docs/source/conf.py
 include docs/source/coverage/extract_source.py
 include docs/[mM]ake*
 recursive-include . *.gitkeep
 recursive-include docs/source *.rst
 recursive-include tests *.py
 graft docs/source/_static
 graft tests/fixtures
 prune docs/source/api
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -0,0 +1,19 @@
 # Minimal makefile for Sphinx documentation
 #

 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SOURCEDIR     = source
 BUILDDIR      = build

 # Put it first so that "make" without argument is like "make help".
 help:
 	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

 .PHONY: help Makefile

 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
--- a/docs/make.bat
+++ b/docs/make.bat
@@ -0,0 +1,35 @@
@ECHO OFF

 pushd %~dp0

 REM Command file for Sphinx documentation

 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
 set SOURCEDIR=source
 set BUILDDIR=build

 if "%1" == "" goto help

 %SPHINXBUILD% >NUL 2>NUL
 if errorlevel 9009 (
 	echo.
 	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
 	echo.installed, then set the SPHINXBUILD environment variable to point
 	echo.to the full path of the 'sphinx-build' executable. Alternatively you
 	echo.may add the Sphinx directory to PATH.
 	echo.
 	echo.If you don't have Sphinx installed, grab it from
 	echo.http://sphinx-doc.org/
 	exit /b 1
 )

 %SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
 goto end

 :help
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%

 :end
 popd
--- a/docs/source/_static/.gitkeep
+++ b/docs/source/_static/.gitkeep
--- a/docs/source/_static/css/coverage.css
+++ b/docs/source/_static/css/coverage.css
@@ -0,0 +1,72 @@
 /* Source file styles */
 p {
    margin: 0;
    padding: 0 0 0 .5em;
    border-left: 2px solid #ffffff;
    white-space: pre;
    position: relative;
    }
 p.mis {
    background: #ffdddd;
    border-left: 2px solid #ff0000;
    }
 p.run, p.run.hide_par {
    background: #ddffdd;
    border-left: 2px solid #00ff00;
    }
 p.exc {
    background: #eeeeee;
    border-left: 2px solid #808080;
    }
 p.par, p.par.hide_run {
    background: #ffffaa;
    border-left: 2px solid #eeee99;
    }
 p.hide_run, p.hide_exc, p.hide_mis, p.hide_par,
 p.hide_run.hide_par {
    background: inherit;
    }
 span.annotate {
    font-family: georgia;
    color: #666;
    float: right;
    padding-right: .5em;
    }
 p.hide_par span.annotate {
    display: none;
    }
 span.annotate.long {
    display: none;
    }
 p:hover span.annotate.long {
    display: block;
    max-width: 50%;
    white-space: normal;
    float: right;
    position: absolute;
    top: 1.75em;
    right: 1em;
    width: 30em;
    height: auto;
    color: #333;
    background: #ffffcc;
    border: 1px solid #888;
    padding: .25em .5em;
    z-index: 999;
    border-radius: .2em;
    box-shadow: #cccccc .2em .2em .2em;
    }

 /* Syntax coloring */
 .com {
    color: green;
    font-style: italic;
    line-height: 1px;
    }
 .key {
    font-weight: bold;
    line-height: 1px;
    }
 .str {
    color: #000080;
    }
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -0,0 +1,264 @@
 # -*- coding: utf-8 -*-
 # pylint: disable=invalid-name
 #
 # Configuration file for the Sphinx documentation builder.
 #
 # This file does only contain a selection of the most common options. For a
 # full list see the documentation:
 # http://www.sphinx-doc.org/en/master/config

 # -- Path setup --------------------------------------------------------------

 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
 import os
 import sys

 from shm_dict._version import __version__  # pylint: disable=wrong-import-position

 # Add base directory to path
 # (shm_dict/docs/source/conf.py -> shm_dict/docs/source -> shm_dict/docs -> shm_dict)
 sys.path.insert(
    0, os.path.dirname(os.path.dirname(os.path.dirname(os.path.abspath(__file__))))
 )


 # -- Project information -----------------------------------------------------

 project = "Shared Memory Dictionary"
 copyright = "2019, Nate Bohman"  # pylint: disable=redefined-builtin
 author = "Nate Bohman"

 # The short X.Y version
 # version = ''
 version = __version__
 # The full version, including alpha/beta/rc tags
 # release = '2018.10.25.12.00'
 release = __version__

 # -- General configuration ---------------------------------------------------

 # If your documentation needs a minimal Sphinx version, state it here.
 #
 # needs_sphinx = '1.0'

 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
    "sphinx_automodapi.automodapi",
    "sphinx_automodapi.smart_resolver",
    "sphinx.ext.autodoc",
    "sphinx.ext.doctest",
    "sphinx.ext.inheritance_diagram",
    "sphinx.ext.intersphinx",
    "sphinx.ext.todo",
    "sphinx.ext.coverage",
    "sphinx.ext.imgmath",
    "sphinx.ext.ifconfig",
    "sphinx.ext.viewcode",
    "sphinx.ext.githubpages",
    "sphinx.ext.napoleon",
 ]

 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
 source_suffix = ".rst"

 # The master toctree document.
 master_doc = "index"

 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
 language = None

 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []

 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"

 # List of warnings to suppress when generating documentation.
 suppress_warnings = [
    "misc.highlighting_failure",
    "ref.doc",
    "ref.numref",
    "ref.ref",
    "toc.secnum",
 ]


 # -- Options for HTML output -------------------------------------------------

 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
 html_theme = "alabaster"

 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 # html_theme_options = {}

 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]

 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
 #
 # The default sidebars (for documents that don't match any pattern) are
 # defined by theme itself.  Builtin themes are using these templates by
 # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
 # 'searchbox.html']``.
 #
 # html_sidebars = {}

 # -- Options for HTMLHelp output ---------------------------------------------

 # Output file base name for HTML help builder.
 htmlhelp_basename = "SharedMemoryDictionarydoc"


 # -- Options for LaTeX output ------------------------------------------------

 latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',
    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',
    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
 }

 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
    (
        master_doc,
        "SharedMemoryDictionary.tex",
        "Shared Memory Dictionary Documentation",
        "Nate Bohman",
        "manual",
    )
 ]


 # -- Options for manual page output ------------------------------------------

 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
    (master_doc, "shm_dict", "Shared Memory Dictionary Documentation", [author], 1)
 ]


 # -- Options for Texinfo output ----------------------------------------------

 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
    (
        master_doc,
        "shm_dict",
        "Shared Memory Dictionary Documentation",
        author,
        "SharedMemoryDictionary",
        "Shared Memory Dictionary Documentation.",
        "Miscellaneous",
    )
 ]


 # -- Options for Epub output -------------------------------------------------

 # Bibliographic Dublin Core info.
 epub_title = project

 # The unique identifier of the text. This can be a ISBN number
 # or the project homepage.
 #
 # epub_identifier = ''

 # A unique identification for the text.
 #
 # epub_uid = ''

 # A list of files that should not be packed into the epub file.
 epub_exclude_files = ["search.html"]


 # -- Extension configuration -------------------------------------------------

 # -- Options for intersphinx extension ---------------------------------------

 # Example configuration for intersphinx: refer to the Python standard library.
 # The URL is the first tuple item. Check with
 # "python -m sphinx.ext.intersphinx 'URL/objects.inv'"
 # and use the second tuple item to specify the
 # name if not the default objects.inv
 intersphinx_mapping = {
    "arrow": ("https://arrow.readthedocs.io/en/latest/", None),
    "python": ("https://docs.python.org/3", None),
    "requests": ("http://docs.python-requests.org/en/master/", None),
    "six": ("https://six.readthedocs.io/", None),
    "urllib3": ("https://urllib3.readthedocs.io/en/latest/", None),
 }

 # -- Options for todo extension ----------------------------------------------

 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True

 # -- Options for autodoc extension -------------------------------------------

 autodoc_default_options = {
    "member-order": "bysource",
    "special-members": "__init__",
    "exclude-members": "__weakref__",
    "show-inheritance": None,
 }

 # -- Options for automodapi extension ----------------------------------------

 # This is needed to avoid having methods and attributes of classes
 # being shown multiple times.
 numpydoc_show_class_members = False

 # If True, members that a class inherits from a base class are included
 # in the generated documentation.
 # automodsumm_inherited_members = False

 # -- Options for inheritance-graph extension ---------------------------------

 inheritance_graph_attrs = dict(
    fontsize=14, size=200, splines="spline", ratio="auto", rankdir="LR"
 )
 inheritance_node_attrs = dict(shape="ellipse", fontsize=14, height=0.75)


 # Add custom stylesheets
 def setup(app):
    app.add_stylesheet("css/coverage.css")
--- a/docs/source/coverage/extract_source.py
+++ b/docs/source/coverage/extract_source.py
@@ -0,0 +1,39 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-

 import os

 from bs4 import BeautifulSoup
 from bs4.element import Tag as bs4_Tag

 __author__ = "Nate Bohman"
 __credits__ = ["Nate Bohman"]
 __license__ = "LGPL-3"
 __maintainer__ = "Nate Bohman"
 __email__ = "natrinicle@natrinicle.com"
 __status__ = "Production"

 COVERAGE_PATH = os.path.abspath(os.path.dirname(__file__))


 for filename in os.listdir(COVERAGE_PATH):
    if filename.endswith("_py.html"):
        # Cut off .html and add .source.html
        source_only_filename = "{}.source.html".format(filename[:-5])
        with open(os.path.join(COVERAGE_PATH, filename), "r") as file:
            soup = BeautifulSoup(file.read(), "html.parser")
        source_div = soup.find(id="source")
        source_text_td = source_div.find_all("td", {"class": "text"})[0]
        with open(
            os.path.join(COVERAGE_PATH, source_only_filename), "w"
        ) as output_file:
            for line in source_text_td.contents:
                if isinstance(line, (bs4_Tag)):
                    try:
                        output_file.write("{}\n".format(line))
                    except UnicodeEncodeError:
                        output_file.write(
                            "{}\n".format(line)
                            .encode("ascii", "ignore")
                            .decode("ascii")
                        )
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -0,0 +1,31 @@
 .. Shared Memory Dictionary documentation master file, created by
   sphinx-quickstart on Wed Aug 21 10:21:58 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

 Welcome to the Shard Memory Dictionary's documentation!
 =======================================================

 +---------------------------------------+-----------------------------------+
 |                                       |                                   |
 | **Modules**                           | * :ref:`search`                   |
 |                                       |                                   |
 +---------------------------------------+-----------------------------------+
 |                                       |                                   |
 | * :ref:`shm_dict.shm_dict`            | * Full index of all callables     |
 |                                       |                                   |
 |                                       |   * :ref:`genindex`               |
 |                                       |                                   |
 |                                       | * Index based on file/directory   |
 |                                       |                                   |
 |                                       |   * :ref:`modindex`               |
 |                                       |                                   |
 +---------------------------------------+-----------------------------------+



 .. toctree::
   :hidden:
   :glob:

   shm_dict/*
--- a/docs/source/shm_dict/shm_dict.rst
+++ b/docs/source/shm_dict/shm_dict.rst
@@ -0,0 +1,19 @@
 .. _shm_dict.shm_dict:

 Shared Memory Dictionary
 ========================

 This is the Shared Memory Dictionary library that
 provides the SHMDict object. This dictionary may
 be kept only in RAM or can be synced to disk if
 persistence is required. A kernel semaphore
 ensures that the dictionary is thread and
 multi-process safe.

 .. automodapi:: shm_dict.shm_dict

 shm_dict.shm_dict Coverage
 --------------------------

 .. raw:: html
    :file: ../coverage/shm_dict_shm_dict_py.source.html
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -0,0 +1,26 @@

 # NOTE: you have to use single-quoted strings in TOML for regular expressions.
 # It's the equivalent of r-strings in Python.  Multiline strings are treated as
 # verbose regular expressions by Black.  Use [ ] to denote a significant space
 # character.

 [tool.black]
 line-length = 88
 skip-numeric-underscore-normalization = true # We can remove this when Python2 goes away
 include = '\.pyi?$'
 exclude = '''
 /(
    \.eggs
  | \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
  | tests/fixtures
  | docs/source
 )/
 '''
--- a/requirements-all.txt
+++ b/requirements-all.txt
@@ -0,0 +1,2 @@
 -r requirements-dev.txt
 -r requirements.txt
--- a/requirements-dev.txt
+++ b/requirements-dev.txt
@@ -0,0 +1,25 @@
 black; python_version >= "3.6"
 check-manifest
 coverage
 docutils
 flake8
 isort
 mock
 pre-commit
 pur
 pygments
 pylint==1.9.4; python_version >= "2.7" and python_version < "3.0"
 pylint; python_version >= "3.4"
 pyOpenSSL
 pytest
 pytest-cov
 pytest-mock
 pytest-runner
 pytest-sugar
 pytest-xdist
 python-language-server[all]
 readme-renderer[md]
 sphinx
 sphinx-automodapi
 tox
 twine
--- a/requirements.txt
+++ b/requirements.txt
@@ -0,0 +1,2 @@
 posix_ipc
 six
--- a/setup.cfg
+++ b/setup.cfg
@@ -0,0 +1,48 @@
 [aliases]
 test = pytest

 [bdist_wheel]
 # Only use the --universal setting, if:
 # 1. Your project runs on Python 2 and 3 with no changes (i.e. it does not require 2to3).
 # 2. Your project does not have any C extensions.
 universal=1

 #[entry_points]
 # Add here console scripts like:
 # console_scripts =
 #     script_name = tsfresh.module:function
 # For example:
 # console_scripts =
 #     fibonacci = tsfresh.skeleton:run
 # as well as other entry_points.

 [coverage:run]
 source = shm_dict
 omit = shm_dict/_version.py

 [coverage:html]
 directory = docs/source/coverage
 title = "Shared Memory Dictionary Coverage Report"

 [devpi:upload]
 # Options for the devpi: PyPI server and packaging tool
 formats = bdist_wheel,sdist.tgz
 with-docs = 1

 [tool:pytest]
 python_files = tests/*.py
 filterwarnings =
  ignore:.*You passed a bytestring.*This will not work on Python 3.*:DeprecationWarning

 [build_sphinx]
 all-files = True
 source-dir = docs/source
 build-dir = docs/build
 builder = html

 [flake8]
 max-line-length = 100
 ignore = F401, W503
 exclude = .git,.tox,.venv,tests/*,build/*,doc/_build/*,sphinx/search/*,doc/usage/extensions/example*.py
 application-import-names = shm_dict
 import-order-style = smarkets
--- a/setup.py
+++ b/setup.py
@@ -0,0 +1,44 @@
 # -*- coding: utf-8 -*-

 import warnings

 from setuptools import find_packages, setup

 # Ignore the normalizing version userwarning so git tagging works better
 # UserWarning: Normalizing '2019.01.03.19.01' to '2019.1.3.19.1'
 warnings.filterwarnings("ignore", ".*Normalizing.*", UserWarning)

 # Pull in __version__ and __version_info__ from _version.py
 exec(
    "".join(
        [
            _
            for _ in open("shm_dict/_version.py").readlines()
            if _.startswith("__version")
        ]
    )
 )  # pylint: disable=exec-used

 setup(
    name="shm_dict",
    version=__version__,  # pylint: disable=undefined-variable
    description="Shared Memory Dictionary",
    long_description=open("README.md").read(),
    long_description_content_type="text/markdown",
    author="Nate Bohman",
    author_email="natrinicle@natrinicle.com",
    url="https://natrinicle.com",
    license="LGPL-3",
    keywords="posix ipc semaphore shm shared memory dict dictionary",
    project_urls={"Source": "https://git.natrinicle.com/natrinicle/shm_dict.git"},
    packages=find_packages(),
    install_requires=open("requirements.txt").read().split("\n"),
    extras_require={"dev": open("requirements-dev.txt").read().split("\n")},
    tests_require=open("requirements-dev.txt").read().split("\n"),
    classifiers=[
        "Programming Language :: Python :: 2",
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: GNU Library or Lesser General Public License (LGPL)",
        "Operating System :: POSIX :: Linux",
    ],
 )
--- a/shm_dict/__init__.py
+++ b/shm_dict/__init__.py
@@ -0,0 +1,8 @@
 # -*- coding: utf-8 -*-

 from pkgutil import extend_path

 __path__ = extend_path(__path__, __name__)

 from ._version import __version__
 from .shm_dict import SHMDict
--- a/shm_dict/_version.py
+++ b/shm_dict/_version.py
@@ -0,0 +1,36 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-

 __version__ = "2019.08.21.20.19"
 __version_info__ = tuple([int(num) for num in __version__.split(".")])


 if __name__ == "__main__":
    from datetime import datetime

    # Open this file in read plus write mode
    with open(__file__, "r+") as file:
        contents = ""

        # Calculate the version strings
        old_version = __version__
        new_version = datetime.utcnow().strftime("%Y.%m.%d.%H.%M")

        # Read through current file and replace
        # the old datetime stamp with the new
        # UTC datetime stamp
        for line in file.read().split("\n"):
            if line.startswith("__version__ = "):
                line = '__version__ = "{}"'.format(new_version)
            contents = "{}{}\n".format(contents, line)

        # Remove extraneous newline from end of contents
        contents = contents[:-1]

        # Seek back to the beginning of the file
        file.seek(0)
        # Erase the contents
        file.truncate()
        # Write the new contents
        file.write(contents)
        print("Changing version from {} to {}".format(old_version, new_version))
--- a/shm_dict/shm_dict.py
+++ b/shm_dict/shm_dict.py
@@ -0,0 +1,310 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-

 # Standard library imports
 import base64

 try:
    from collections.abc import MutableMapping
 except ImportError:
    from collections import MutableMapping

 from contextlib import contextmanager
 import hashlib
 import logging
 from math import ceil
 import mmap
 import os
 import pickle  # nosec
 import sys
 import threading

 import posix_ipc
 import six

 # Local application/library specific imports (Look ma! I wrote it myself!)
 from ._version import __version__

 __author__ = "Nate Bohman"
 __credits__ = ["Nate Bohman"]
 __license__ = "LGPL-3"
 __maintainer__ = "Nate Bohman"
 __email__ = "natrinicle@natrinicle.com"
 __status__ = "Production"

 # Get the current working directory and add it to the sys.path unless it's already in there.
 CWD = os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
 if CWD not in sys.path:
    sys.path.append(CWD)

 logger = logging.getLogger(__name__)  # pylint: disable=invalid-name


 class SHMDict(MutableMapping):
    """Python shared memory file descriptor.

    :param name: Name for shared memory and semaphore if volatile
                 or path to file if persistent.
    :param persist: True if name is the path to a file and this
                    shared memory dictionary should be written
                    out to the file for persistence between runs
                    and/or processes.
    :param lock_timeout: Time in seconds before giving up on
                         acquiring an exclusive lock to the
                         dictionary.
    :param auto_unlock: If the lock_timeout is hit, and this
                        is True, automatically bypass the
                        lock and use the dictionary anyway.
    :type name: :class:`str`
    :type persist: :class:`bool`
    :type lock_timeout: :class:`int` or :class:`float`
    :type auto_unlock: :class:`bool`
    """

    def __init__(self, name, persist=False, lock_timeout=30, auto_unlock=False):
        self.name = name
        self.persist_file = None
        self.lock_timeout = lock_timeout
        self.auto_unlock = auto_unlock
        self._semaphore = None
        self._map_file = None
        self.__thread_local = threading.local()
        self.__thread_local.semaphore = False
        self.__internal_dict = None
        self.__dirty = False

        if persist is True:
            self.persist_file = self.name
            if self.persist_file.startswith("~"):
                self.persist_file = os.path.expanduser(self.persist_file)
            self.persist_file = os.path.abspath(os.path.realpath(self.persist_file))

        super(SHMDict, self).__init__()

    def _safe_name(self, prefix=""):
        """IPC object safe name creator.

        Semaphores and Shared Mmeory names allow up to 256 characters (dependong on OS) and must
        begin with a /.

        :param prefix: A string to prepend followed by _ and
                       then the dictionary's name.
        :type prefix: :class:`str`
        """
        # Hash lengths
        # SHA1: 28
        # SHA256: 44
        # SHA512: 88
        sha_hash = hashlib.sha512()
        sha_hash.update("_".join([prefix, str(self.name)]).encode("utf-8"))
        b64_encode = base64.urlsafe_b64encode(sha_hash.digest())
        return "/{}".format(b64_encode)

    @property
    def safe_sem_name(self):
        """Unique semaphore name based on the dictionary name."""
        return self._safe_name("sem")

    @property
    def safe_shm_name(self):
        """Unique shared memory segment name based on the dictionary name."""
        return self._safe_name("shm")

    @property
    def semaphore(self):
        """Create or return already existing semaphore."""
        if self._semaphore is not None:
            return self._semaphore

        try:
            self._semaphore = posix_ipc.Semaphore(self.safe_sem_name)
        except posix_ipc.ExistentialError:
            self._semaphore = posix_ipc.Semaphore(
                self.safe_sem_name, flags=posix_ipc.O_CREAT, initial_value=1
            )
        return self._semaphore

    @property
    def shared_mem(self):
        """Create or return already existing shared memory object."""
        try:
            return posix_ipc.SharedMemory(
                self.safe_shm_name, size=len(pickle.dumps(self.__internal_dict))
            )
        except posix_ipc.ExistentialError:
            return posix_ipc.SharedMemory(
                self.safe_shm_name, flags=posix_ipc.O_CREX, size=posix_ipc.PAGE_SIZE
            )

    @property
    def map_file(self):
        """Create or return mmap file resizing if necessary."""
        if self._map_file is None:
            self._map_file = mmap.mmap(self.shared_mem.fd, self.shared_mem.size)
            self.shared_mem.close_fd()

        self._map_file.resize(
            int(
                ceil(float(len(pickle.dumps(self.__internal_dict, 2))) / mmap.PAGESIZE)
                * mmap.PAGESIZE
            )
        )
        return self._map_file

    def __load_dict(self):
        """Load dictionary from shared memory or file if persistent and memory empty."""
        # Read in internal data from map_file
        self.map_file.seek(0)
        try:
            self.__internal_dict = pickle.load(self.map_file)  # nosec
        except (KeyError, pickle.UnpicklingError, EOFError):
            # Curtis Pullen found that Python 3.4 throws EOFError
            # instead of UnpicklingError that Python 3.6 throws
            # when attempting to unpickle an empty file.
            pass

        # If map_file is empty and persist_file is true, treat
        # self.name as filename and attempt to load from disk.
        if self.__internal_dict is None and self.persist_file is not None:
            try:
                with open(self.persist_file, "rb") as pfile:
                    self.__internal_dict = pickle.load(pfile)  # nosec
            except IOError:
                pass

        # If map_file is empty, persist_file is False or
        # self.name is empty create a new empty dictionary.
        if self.__internal_dict is None:
            self.__internal_dict = {}

    def __save_dict(self):
        """Save dictionary into shared memory and file if persistent."""
        # Write out internal dict to map_file
        if self.__dirty is True:
            self.map_file.seek(0)
            pickle.dump(self.__internal_dict, self.map_file, 2)

            if self.persist_file is not None:
                with open(self.persist_file, "wb") as pfile:
                    pickle.dump(self.__internal_dict, pfile, 2)

        self.__dirty = False

    def _acquire_lock(self):
        """Acquire an exclusive dict lock.

        Loads dictionary data from memory or disk (if persistent) to
        ensure data is up to date when lock is requested.

        .. warnings also::
            MacOS has a number of shortcomings with regards to
            semaphores and shared memory segments, this is one
            method contains one of them.

                When the timeout is > 0, the call will wait no longer than
                timeout seconds before either returning (having acquired
                the semaphore) or raising a BusyError.
                On platforms that don't support the sem_timedwait() API,
                a timeout > 0 is treated as infinite. The call will not
                return until its wait condition is satisfied.
                Most platforms provide sem_timedwait(). macOS is a notable
                exception. The module's Boolean constant
                SEMAPHORE_TIMEOUT_SUPPORTED is True on platforms that
                support sem_timedwait().

                -- http://semanchuk.com/philip/posix_ipc/
        """
        if self.__thread_local.semaphore is False:
            try:
                self.semaphore.acquire(self.lock_timeout)
                self.__thread_local.semaphore = True
            except posix_ipc.BusyError:
                if self.auto_unlock is True:
                    self.__thread_local.semaphore = True
                else:
                    six.reraise(*sys.exc_info())

        self.__load_dict()

    def _release_lock(self):
        """Release the exclusive semaphore lock."""
        if self.__thread_local.semaphore is True:
            self.__save_dict()
            self.semaphore.release()
            self.__thread_local.semaphore = False

    @contextmanager
    def exclusive_lock(self):
        """A context manager for the lock to allow with statements for exclusive access."""
        self._acquire_lock()
        yield
        self._release_lock()

    def __del__(self):
        """Destroy the object nicely."""
        self.map_file.close()
        self.shared_mem.unlink()
        self.semaphore.unlink()

    def __setitem__(self, key, value):
        """Set a key in the dictionary to a value."""
        with self.exclusive_lock():
            self.__internal_dict[key] = value
            self.__dirty = True

    def __getitem__(self, key):
        """Get the value of a key from the dictionary."""
        with self.exclusive_lock():
            return self.__internal_dict[key]

    def __repr__(self):
        """Represent the dictionary in a human readable format."""
        with self.exclusive_lock():
            return repr(self.__internal_dict)

    def __len__(self):
        """Return the length of the dictionary."""
        with self.exclusive_lock():
            return len(self.__internal_dict)

    def __delitem__(self, key):
        """Remove an item from the dictionary."""
        with self.exclusive_lock():
            del self.__internal_dict[key]
            self.__dirty = True

    def clear(self):
        """Completely clear the dictionary."""
        with self.exclusive_lock():
            self.__dirty = True
            return self.__internal_dict.clear()

    def copy(self):
        """Create and return a copy of the internal dictionary."""
        with self.exclusive_lock():
            return self.__internal_dict.copy()

    def has_key(self, key):
        """Return true if a key is in the internal dictionary."""
        with self.exclusive_lock():
            return key in self.__internal_dict

    def __eq__(self, other):
        """Shared memory dictionary equality check with another shared memory dictionary."""
        return isinstance(other, SHMDict) and self.safe_shm_name == other.safe_shm_name

    def __ne__(self, other):
        """Shared memory dictionary non-equality check with another shared memory dictionary."""
        return not isinstance(other, SHMDict) or (
            isinstance(other, SHMDict) and self.safe_shm_name != other.safe_shm_name
        )

    def __contains__(self, key):
        """Check if a key exists inside the dictionary."""
        with self.exclusive_lock():
            return key in self.__internal_dict

    def __iter__(self):
        """Iterate through the dictionary keys."""
        with self.exclusive_lock():
            return iter(self.__internal_dict)
--- a/shm_dict/shm_dict.py.20190821
+++ b/shm_dict/shm_dict.py.20190821
@@ -0,0 +1,338 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-

 # Standard library imports
 import base64
 from contextlib import contextmanager
 import hashlib
 import logging
 from math import ceil
 import mmap
 import os
 import pickle  # nosec
 import sys
 import threading

 import posix_ipc
 import six

 # Local application/library specific imports (Look ma! I wrote it myself!)
 from ._version import __version__

 __author__ = "Nate Bohman"
 __credits__ = ["Nate Bohman"]
 __license__ = "LGPL-3"
 __maintainer__ = "Nate Bohman"
 __email__ = "natrinicle@natrinicle.com"
 __status__ = "Production"

 # Get the current working directory and add it to the sys.path unless it's already in there.
 CWD = os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
 if CWD not in sys.path:
    sys.path.append(CWD)

 logger = logging.getLogger(__name__)  # pylint: disable=invalid-name


 class SHMDict(dict):
    """Python shared memory file descriptor.

    :param name: Name for shared memory and semaphore if volatile
                 or path to file if persistent.
    :param persist: True if name is the path to a file and this
                    shared memory dictionary should be written
                    out to the file for persistence between runs
                    and/or processes.
    :param lock_timeout: Time in seconds before giving up on
                         acquiring an exclusive lock to the
                         dictionary.
    :param auto_unlock: If the lock_timeout is hit, and this
                        is True, automatically bypass the
                        lock and use the dictionary anyway.
    :type name: :class:`str`
    :type persist: :class:`bool`
    :type lock_timeout: :class:`int` or :class:`float`
    :type auto_unlock: :class:`bool`
    """

    def __init__(self, name, persist=False, lock_timeout=30, auto_unlock=False):
        self.name = name
        self.persist_file = None
        self.lock_timeout = lock_timeout
        self.auto_unlock = auto_unlock
        self._semaphore = None
        self._map_file = None
        self.__thread_local = threading.local()
        self.__thread_local.semaphore = False
        self.__internal_dict = None
        self.__dirty = False

        if persist is True:
            self.persist_file = self.name
            if self.persist_file.startswith("~"):
                self.persist_file = os.path.expanduser(self.persist_file)
            self.persist_file = os.path.abspath(os.path.realpath(self.persist_file))

        super(SHMDict, self).__init__()

    def _safe_name(self, prefix=""):
        """IPC object safe name creator.

        Semaphores and Shared Mmeory names allow up to 256 characters (dependong on OS) and must
        begin with a /.

        :param prefix: A string to prepend followed by _ and
                       then the dictionary's name.
        :type prefix: :class:`str`
        """
        # Hash lengths
        # SHA1: 28
        # SHA256: 44
        # SHA512: 88
        sha_hash = hashlib.sha512()
        sha_hash.update("_".join([prefix, str(self.name)]).encode("utf-8"))
        b64_encode = base64.urlsafe_b64encode(sha_hash.digest())
        return "/{}".format(b64_encode)

    @property
    def safe_sem_name(self):
        """Unique semaphore name based on the dictionary name."""
        return self._safe_name("sem")

    @property
    def safe_shm_name(self):
        """Unique shared memory segment name based on the dictionary name."""
        return self._safe_name("shm")

    @property
    def semaphore(self):
        """Create or return already existing semaphore."""
        if self._semaphore is not None:
            return self._semaphore

        try:
            self._semaphore = posix_ipc.Semaphore(self.safe_sem_name)
        except posix_ipc.ExistentialError:
            self._semaphore = posix_ipc.Semaphore(
                self.safe_sem_name, flags=posix_ipc.O_CREAT, initial_value=1
            )
        return self._semaphore

    @property
    def shared_mem(self):
        """Create or return already existing shared memory object."""
        try:
            return posix_ipc.SharedMemory(
                self.safe_shm_name, size=len(pickle.dumps(self.__internal_dict))
            )
        except posix_ipc.ExistentialError:
            return posix_ipc.SharedMemory(
                self.safe_shm_name, flags=posix_ipc.O_CREX, size=posix_ipc.PAGE_SIZE
            )

    @property
    def map_file(self):
        """Create or return mmap file resizing if necessary."""
        if self._map_file is None:
            self._map_file = mmap.mmap(self.shared_mem.fd, self.shared_mem.size)
            self.shared_mem.close_fd()

        self._map_file.resize(
            int(
                ceil(float(len(pickle.dumps(self.__internal_dict, 2))) / mmap.PAGESIZE)
                * mmap.PAGESIZE
            )
        )
        return self._map_file

    def __load_dict(self):
        """Load dictionary from shared memory or file if persistent and memory empty."""
        # Read in internal data from map_file
        self.map_file.seek(0)
        try:
            self.__internal_dict = pickle.load(self.map_file)  # nosec
        except (KeyError, pickle.UnpicklingError, EOFError):
            # Curtis Pullen found that Python 3.4 throws EOFError
            # instead of UnpicklingError that Python 3.6 throws
            # when attempting to unpickle an empty file.
            pass

        # If map_file is empty and persist_file is true, treat
        # self.name as filename and attempt to load from disk.
        if self.__internal_dict is None and self.persist_file is not None:
            try:
                with open(self.persist_file, "rb") as pfile:
                    self.__internal_dict = pickle.load(pfile)  # nosec
            except IOError:
                pass

        # If map_file is empty, persist_file is False or
        # self.name is empty create a new empty dictionary.
        if self.__internal_dict is None:
            self.__internal_dict = {}

    def __save_dict(self):
        """Save dictionary into shared memory and file if persistent."""
        # Write out internal dict to map_file
        if self.__dirty is True:
            self.map_file.seek(0)
            pickle.dump(self.__internal_dict, self.map_file, 2)

            if self.persist_file is not None:
                with open(self.persist_file, "wb") as pfile:
                    pickle.dump(self.__internal_dict, pfile, 2)

        self.__dirty = False

    def _acquire_lock(self):
        """Acquire an exclusive dict lock.

        Loads dictionary data from memory or disk (if persistent) to
        ensure data is up to date when lock is requested.

        .. warnings also::
            MacOS has a number of shortcomings with regards to
            semaphores and shared memory segments, this is one
            method contains one of them.

                When the timeout is > 0, the call will wait no longer than
                timeout seconds before either returning (having acquired
                the semaphore) or raising a BusyError.
                On platforms that don't support the sem_timedwait() API,
                a timeout > 0 is treated as infinite. The call will not
                return until its wait condition is satisfied.
                Most platforms provide sem_timedwait(). macOS is a notable
                exception. The module's Boolean constant
                SEMAPHORE_TIMEOUT_SUPPORTED is True on platforms that
                support sem_timedwait().

                -- http://semanchuk.com/philip/posix_ipc/
        """
        if self.__thread_local.semaphore is False:
            try:
                self.semaphore.acquire(self.lock_timeout)
                self.__thread_local.semaphore = True
            except posix_ipc.BusyError:
                if self.auto_unlock is True:
                    self.__thread_local.semaphore = True
                else:
                    six.reraise(*sys.exc_info())

        self.__load_dict()

    def _release_lock(self):
        """Release the exclusive semaphore lock."""
        if self.__thread_local.semaphore is True:
            self.__save_dict()
            self.semaphore.release()
            self.__thread_local.semaphore = False

    @contextmanager
    def exclusive_lock(self):
        """A context manager for the lock to allow with statements for exclusive access."""
        self._acquire_lock()
        yield
        self._release_lock()

    def __del__(self):
        """Destroy the object nicely."""
        self.map_file.close()
        self.shared_mem.unlink()
        self.semaphore.unlink()

    def __setitem__(self, key, value):
        """Set a key in the dictionary to a value."""
        with self.exclusive_lock():
            self.__internal_dict[key] = value
            self.__dirty = True

    def __getitem__(self, key):
        """Get the value of a key from the dictionary."""
        with self.exclusive_lock():
            return self.__internal_dict[key]

    def __repr__(self):
        """Represent the dictionary in a human readable format."""
        with self.exclusive_lock():
            return repr(self.__internal_dict)

    def __len__(self):
        """Return the length of the dictionary."""
        with self.exclusive_lock():
            return len(self.__internal_dict)

    def __delitem__(self, key):
        """Remove an item from the dictionary."""
        with self.exclusive_lock():
            del self.__internal_dict[key]
            self.__dirty = True

    def clear(self):
        """Completely clear the dictionary."""
        with self.exclusive_lock():
            self.__dirty = True
            return self.__internal_dict.clear()

    def copy(self):
        """Create and return a copy of the internal dictionary."""
        with self.exclusive_lock():
            return self.__internal_dict.copy()

    def has_key(self, key):
        """Return true if a key is in the internal dictionary."""
        with self.exclusive_lock():
            return key in self.__internal_dict

    def update(self, *args, **kwargs):
        """Update keys in the dictionary to new values."""
        with self.exclusive_lock():
            self.__dirty = True
            return self.__internal_dict.update(*args, **kwargs)

    def keys(self):
        """Keys the dictionary contains."""
        with self.exclusive_lock():
            return self.__internal_dict.keys()

    def values(self):
        """Values the dictionary contains."""
        with self.exclusive_lock():
            return self.__internal_dict.values()

    def items(self):
        """Key, value pairs that the dictionary contains."""
        with self.exclusive_lock():
            return self.__internal_dict.items()

    def pop(self, *args, **kwargs):
        """Pop an item from the end of the dictionary."""
        with self.exclusive_lock():
            self.__dirty = True
            return self.__internal_dict.pop(*args, **kwargs)

    def get(self, key, default=None):
        """Get a key from the dictionary if it exists or the default value if not."""
        with self.exclusive_lock():
            if key in self.__internal_dict:
                return self.__internal_dict[key]
            return default

    def __eq__(self, other):
        """Shared memory dictionary equality check with another shared memory dictionary."""
        return isinstance(other, SHMDict) and self.safe_shm_name == other.safe_shm_name

    def __ne__(self, other):
        """Shared memory dictionary non-equality check with another shared memory dictionary."""
        return not isinstance(other, SHMDict) or (
            isinstance(other, SHMDict) and self.safe_shm_name != other.safe_shm_name
        )

    def __contains__(self, key):
        """Check if a key exists inside the dictionary."""
        with self.exclusive_lock():
            return key in self.__internal_dict

    def __iter__(self):
        """Iterate through the dictionary keys."""
        with self.exclusive_lock():
            return iter(self.__internal_dict)
--- a/test
+++ b/test
--- a/tests/__init__.py
+++ b/tests/__init__.py
@@ -0,0 +1,3 @@
 from pkg_resources import get_distribution

 __version__ = get_distribution('shm_dict').version
--- a/tests/test_shm_dict.py
+++ b/tests/test_shm_dict.py
@@ -0,0 +1,306 @@
 # -*- coding: utf-8 -*-

 # Standard library imports
 try:
    from collections.abc import MutableMapping
 except ImportError:
    from collections import MutableMapping

 import mmap
 import mock
 import os
 from random import SystemRandom
 import re
 from string import ascii_letters as str_ascii_letters, digits as str_digits

 # Related third party imports (If you used pip/apt/yum to install)
 import posix_ipc
 import pytest

 # Local application/library specific imports (Look ma! I wrote it myself!)
 import shm_dict
 from shm_dict import SHMDict
 from shm_dict import __version__

 __author__ = "Nate Bohman"
 __credits__ = ["Nate Bohman"]
 __license__ = "LGPL-3"
 __maintainer__ = "Nate Bohman"
 __email__ = "natrinicle@natrinicle.com"
 __status__ = "Production"


 # Global variables
 KEY_SEQUENCE = 0
 B64_INVALID_CHARS = re.compile(r"[^a-zA-Z0-9+/='-_]")
 str_ascii = "".join([str_ascii_letters, str_digits])


 def rand_string(num_chars, use_chars=str_ascii):
    """Generate a random string of chars from use_chars.

    :type num_chars: int
    :param num_chars: Desired length of random string.
    :return: A string of length num_chars composed of random characters from use_chars.
    """
    return "".join(SystemRandom().choice(use_chars) for _ in range(num_chars))


@pytest.fixture()
 def dict_key():
    global KEY_SEQUENCE
    next_key = "KEY{}".format(KEY_SEQUENCE)
    KEY_SEQUENCE += 1
    return next_key


@pytest.fixture
 def os_path_mock(monkeypatch, tmpdir):
    """Disable looking up actual paths."""

    def _return_tmp_file(arg):
        return str(
            os.path.join(str(tmpdir), "".join(["pytest_shm_dict_", rand_string(10)]))
        )

    os_path_mock = mock.Mock()
    attrs = {
        "expanduser.side_effect": _return_tmp_file,
        "realpath.side_effect": _return_tmp_file,
        "abspath.side_effect": _return_tmp_file,
    }
    os_path_mock.configure_mock(**attrs)

    return os_path_mock


 class TestSHMDict(object):

    _tmpfile_prefix = "pytest_shm_dict_"
    _tmpfile_rand = ""
    per_shm_dict = None
    vol_shm_dict = None

    def create_per_shm_dict(self, temp_dir):
        """Create a persistent shared memory dictionary for testing."""
        self.per_shm_dict = SHMDict(
            self.dict_filename(temp_dir), persist=True, lock_timeout=0
        )
        return self.per_shm_dict

    def create_vol_shm_dict(self):
        """Create a volatile shared memory dictionary for testing."""
        self.vol_shm_dict = SHMDict("PyTestSHMDict", lock_timeout=0)
        return self.vol_shm_dict

    def dict_filename(self, temp_dir):
        return os.path.join(
            str(temp_dir), "".join([self._tmpfile_prefix, self._tmpfile_rand])
        )

    def setup_method(self, method):
        # Set up one time random string for temp filename and make
        # sure the temp test file doesn't already exist
        self._tmpfile_rand = rand_string(10)

    def teardown_method(self, method):
        if self.per_shm_dict is not None:
            while self.per_shm_dict.semaphore.value > 0:
                self.per_shm_dict.semaphore.acquire()
            while self.per_shm_dict.semaphore.value <= 0:
                self.per_shm_dict.semaphore.release()
            del self.per_shm_dict

        if self.vol_shm_dict is not None:
            while self.vol_shm_dict.semaphore.value > 0:
                self.vol_shm_dict.semaphore.acquire()
            while self.vol_shm_dict.semaphore.value <= 0:
                self.vol_shm_dict.semaphore.release()
            del self.vol_shm_dict

    def test_types(self):
        self.create_per_shm_dict("test")
        self.create_vol_shm_dict()

        assert isinstance(self.per_shm_dict, MutableMapping)
        assert isinstance(self.vol_shm_dict, MutableMapping)
        assert isinstance(self.per_shm_dict, SHMDict)
        assert isinstance(self.vol_shm_dict, SHMDict)

        assert isinstance(self.per_shm_dict.semaphore, posix_ipc.Semaphore)
        assert isinstance(self.vol_shm_dict.semaphore, posix_ipc.Semaphore)

        assert isinstance(self.per_shm_dict.shared_mem, posix_ipc.SharedMemory)
        assert isinstance(self.vol_shm_dict.shared_mem, posix_ipc.SharedMemory)

        assert isinstance(self.per_shm_dict.map_file, mmap.mmap)
        assert isinstance(self.vol_shm_dict.map_file, mmap.mmap)

    def test_persist_filename(self, monkeypatch, os_path_mock):
        with monkeypatch.context() as monkey:
            monkey.setattr("os.path", os_path_mock)
            self.create_per_shm_dict("test")
            self.create_vol_shm_dict()

            # Ensure persistent shm_dict has a str representation
            # of a path in persist_file
            assert isinstance(self.per_shm_dict.persist_file, str)
            assert self.per_shm_dict.persist_file == os.path.abspath("test")

            # Ensure volatile shm_dict has no persist_file
            assert self.vol_shm_dict.persist_file is None

    def test_persist_filename_homedir(self, monkeypatch, os_path_mock):
        with monkeypatch.context() as monkey:
            monkey.setattr("os.path", os_path_mock)
            self.create_per_shm_dict("~/test")

            # Ensure persistent shm_dict has a str representation
            # of a path in persist_file
            assert isinstance(self.per_shm_dict.persist_file, str)
            assert self.per_shm_dict.persist_file == os.path.abspath("test")

    def test_safe_names(self, tmpdir):
        self.create_per_shm_dict(tmpdir)

        # Ensure both sem and shm names begin with / per
        # http://semanchuk.com/philip/posix_ipc
        assert self.per_shm_dict.safe_sem_name.startswith("/")
        assert self.per_shm_dict.safe_shm_name.startswith("/")

        # Ensure only base64 characters are used
        assert B64_INVALID_CHARS.search(self.per_shm_dict.safe_sem_name) is None
        assert B64_INVALID_CHARS.search(self.per_shm_dict.safe_shm_name) is None

    def test_persistent_file(self, tmpdir, dict_key):
        """Test that a persistent file is written to disk """
        test_rand_string = rand_string(10)
        self.create_per_shm_dict(tmpdir)
        self.create_vol_shm_dict()

        # File should be created after first dict release
        self.per_shm_dict[dict_key] = test_rand_string

        # Make sure the file exists and the contents are correct
        assert os.path.isfile(self.dict_filename(tmpdir))
        assert self.per_shm_dict.get(dict_key) == test_rand_string

        # Ensure the file exists after dict is deleted
        del self.per_shm_dict
        assert os.path.isfile(self.dict_filename(tmpdir))

        # Re-open dict from test file
        self.create_per_shm_dict(tmpdir)

        # Make sure the contents are still the same after reopening
        assert self.per_shm_dict.get(dict_key) == test_rand_string

    def test_get_set(self, tmpdir, dict_key):
        test_rand_string = rand_string(10)
        self.create_per_shm_dict(tmpdir)
        self.create_vol_shm_dict()

        # Assign value to key and make sure it gets set
        self.per_shm_dict[dict_key] = test_rand_string

        # Check that the persistent dict has the key
        assert self.per_shm_dict.has_key(dict_key) is True

        # Check the value of the key to ensure no corruption
        assert self.per_shm_dict[dict_key] == test_rand_string

        # Use update to set the key in the volatile dict
        # from the value in the persistent dict
        self.vol_shm_dict.update(self.per_shm_dict)

        # Check the keys and values of the volatile dict
        assert list(self.vol_shm_dict.keys()) == [dict_key]
        assert list(self.vol_shm_dict.values()) == [test_rand_string]
        assert list(self.vol_shm_dict.items()) == [(dict_key, test_rand_string)]
        for key in iter(self.vol_shm_dict):
            assert self.vol_shm_dict[key] == test_rand_string

        # Test popping a key from the dictionary
        assert self.vol_shm_dict.pop(dict_key) == test_rand_string
        assert (dict_key in self.vol_shm_dict) == False

        # Delete key and make sure it's deleted
        del self.per_shm_dict[dict_key]
        assert self.per_shm_dict.get(dict_key) is None

    def test_copy(self, tmpdir, dict_key):
        test_rand_string = rand_string(10)
        self.create_per_shm_dict(tmpdir)

        # Assign value to a key and then copy to a
        # testing dictionary object.
        self.per_shm_dict[dict_key] = test_rand_string
        dict_copy = self.per_shm_dict.copy()

        # Delete key from persistent dict and make sure
        # it's deleted only from the persistent dict as
        # the dict copy should be a new dict and not a
        # pointer to the persistent dict.
        assert self.per_shm_dict[dict_key] == test_rand_string
        del self.per_shm_dict[dict_key]
        assert self.per_shm_dict.get(dict_key) is None
        assert dict_copy[dict_key] == test_rand_string
        del dict_copy[dict_key]
        assert dict_copy.get(dict_key) is None

    def test_equality(self, tmpdir, dict_key):
        test_rand_string = rand_string(10)
        self.create_per_shm_dict(tmpdir)
        self.create_vol_shm_dict()

        # Assign value to a key and then copy the pointer
        # to the volatile dict to another object.
        self.vol_shm_dict[dict_key] = test_rand_string
        self.per_shm_dict[dict_key] = test_rand_string
        dict_dup = self.vol_shm_dict

        assert self.vol_shm_dict == dict_dup
        assert (self.vol_shm_dict == {dict_key: test_rand_string}) == False

        assert self.vol_shm_dict != {dict_key: test_rand_string}
        assert self.vol_shm_dict != self.per_shm_dict

    def test_len(self, dict_key):
        self.create_vol_shm_dict()

        # Make sure dict starts out empty
        assert len(self.vol_shm_dict) == 0

        # Add 1 key to the dict and make sure dict has 1 key
        self.vol_shm_dict[dict_key] = rand_string(10)
        assert len(self.vol_shm_dict) == 1

    def test_clear(self, dict_key):
        test_rand_string = rand_string(10)
        self.create_vol_shm_dict()

        # Assign value to key and make sure it gets set
        self.vol_shm_dict[dict_key] = test_rand_string
        assert self.vol_shm_dict[dict_key] == test_rand_string

        # Clean dict and ensure it's empty again
        self.vol_shm_dict.clear()
        assert len(self.vol_shm_dict) == 0

    def test_lock(self):
        self.create_vol_shm_dict()

        # Simulate another thread/process having a lock
        # with the semaphore value at 0 and the internal
        # semaphore not set to true.
        while self.vol_shm_dict.semaphore.value > 0:
            self.vol_shm_dict.semaphore.acquire()

        with pytest.raises(posix_ipc.BusyError, match=r".*Semaphore is busy.*"):
            repr(self.vol_shm_dict)

        # Set auto_unlock to True to ensure the semaphore
        # is automatically released
        self.vol_shm_dict.auto_unlock = True

        repr(self.vol_shm_dict)
--- a/tox.ini
+++ b/tox.ini
@@ -0,0 +1,104 @@
 [tox]
 envlist = cov_init, py{27,35,36,37}, cov_report, docs, bandit, pylint

 [testenv]
 basepython =
  py27: {env:TOXPYTHON:python2.7}
  py35: {env:TOXPYTHON:python3.5}
  py36: {env:TOXPYTHON:python3.6}
  py37: {env:TOXPYTHON:python3.7}
  {bandit,cov_init,cov_report,docs,lint,pur,pylint}: {env:TOXPYTHON:python3}
 setenv =
  COVERAGE_FILE = .coverage.{envname}
  PYTHONPATH={toxinidir}
  PYTHONUNBUFFERED=yes
  HOME={env:HOME:/tmp}
 skip_missing_interpreters = True
 alwayscopy = True
 deps =
  -r {toxinidir}/requirements-all.txt
 commands =
  pytest --durations 25 \
         --basetemp={envtmpdir} \
         --confcutdir=.. \
         --cov \
         -n 0 \
         {posargs}

 [testenv:cov_init]
 setenv =
  COVERAGE_FILE = .coverage
  PYTHONPATH={toxinidir}
  PYTHONUNBUFFERED=yes
  HOME={env:HOME:/tmp}
 deps =
  coverage
 skip_install = True
 commands =
  coverage erase

 [testenv:cov_report]
 setenv =
  COVERAGE_FILE = .coverage
  PYTHONPATH={toxinidir}
  PYTHONUNBUFFERED=yes
  HOME={env:HOME:/tmp}
 deps =
  beautifulsoup4
  coverage
 skip_install = True
 commands =
  coverage combine
  # coverage report
  coverage html
  {toxinidir}/docs/source/coverage/extract_source.py

 [testenv:lint]
 setenv =
  {[testenv]setenv}
 deps =
  -r {toxinidir}/requirements-dev.txt
 ignore_errors = True
 commands =
  twine check {distdir}/*
  pre-commit run --all-files

 [testenv:pur]
 skip_install = True
 description =
  Update all versioned packages in requirements.txt files
 setenv =
  {[testenv]setenv}
 deps =
  pur
 commands =
  pur -r requirements-all.txt

 [testenv:pylint]
 skip_install = True
 setenv =
  {[testenv]setenv}
 deps =
  -r {toxinidir}/requirements-dev.txt
 commands =
  pylint --rcfile=.pylintrc shm_dict

 [testenv:bandit]
 skip_install = True
 setenv =
  {[testenv]setenv}
 deps =
  bandit
 commands =
  bandit -r shm_dict

 [testenv:docs]
 setenv =
  {[testenv]setenv}
 skip_install = True
 description =
  Invoke sphinx-build to build the HTML docs
 deps =
  -r {toxinidir}/requirements-all.txt
 commands =
  python setup.py build_sphinx -q {posargs}