Version 2.0.0 (#28)

* Version 2.0.0

* Version 2.0.0

* Version 2.0.0

* Version 2.0.0

* Version 2.0.0

* Version 2.0.0

* Version 2.0.0

* Version 2.0.0

Author: ofiriluz

.github/workflows/build.yml

@@ -8,7 +8,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11"]
 
     steps:
       - uses: actions/checkout@v4
@@ -37,13 +37,13 @@ jobs:
       - name: Publish
         run: |
           make publish
-        if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.8' }}
+        if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.11' }}
         env:
           TWINE_USERNAME: ${{ secrets.TWINE_PROD_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.TWINE_PROD_PASSWORD }}
       - name: Version
         id: version
-        if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.8' }}
+        if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.11' }}
         run: |
           version=$(poetry version -s | awk '{$1=$1};1')
           echo "Version: $version"
@@ -52,7 +52,7 @@ jobs:
         id: "tag_create"
         continue-on-error: true
         uses: rickstaa/action-create-tag@v1
-        if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.8' }}
+        if: ${{ github.ref == 'refs/heads/main' && matrix.python-version == '3.11' }}
         with:
           tag: v${{ steps.version.outputs.version }}
           tag_exists_error: false

.pylintrc

@@ -5,17 +5,24 @@
 # only in one or another interpreter, leading to false positives when analysed.
 analyse-fallback-blocks=no
 
+# Clear in-memory caches upon conclusion of linting. Useful if running pylint
+# in a server-like mode.
+clear-cache-post-run=no
+
+# Files or directories matching the regular expression patterns are skipped.
+# The regex matches against base names, not paths. The default value ignores
+# Emacs file locks
+# ignore-patterns=^\.#
+ignore-patterns=
+
 # Load and enable all available extensions. Use --list-extensions to see a list
 # all available extensions.
-#enable-all-extensions=
+# enable-all-extensions=pylint.extensions.empty_comment,pylint.extensions.dunder,pylint.extensions.code_style,pylint.extensions.eq_without_hash,pylint.extensions.broad_try_clause,pylint.extensions.consider_refactoring_into_while_condition,pylint.extensions.docparams,pylint.extensions.mccabe,pylint.extensions.dict_init_mutate,pylint.extensions.emptystring,pylint.extensions.comparetozero,pylint.extensions.confusing_elif,pylint.extensions.for_any_all,pylint.extensions.redefined_loop_name,pylint.extensions.consider_ternary_expression,pylint.extensions.while_used,pylint.extensions.magic_value,pylint.extensions.typing,pylint.extensions.redefined_variable_type,pylint.extensions.comparison_placement,pylint.extensions.docstyle,pylint.extensions.check_elif,pylint.extensions.no_self_use,pylint.extensions.private_import,pylint.extensions.set_membership,pylint.extensions.overlapping_exceptions,pylint.extensions.bad_builtin
 
-# Files or directories matching the regex patterns are skipped. The regex
-# matches against base names, not paths. The default value ignores Emacs file
-# locks
-ignore-patterns=
 
-# In error mode, checkers without error messages are disabled and for others,
-# only the ERROR messages are displayed, and no reports are done by default.
+# In error mode, messages with a category besides ERROR or FATAL are
+# suppressed, and no reports are done by default. Error mode is compatible with
+# disabling specific errors.
 #errors-only=
 
 # Always return a 0 (non-error) status code, even if lint errors are found.
@@ -24,26 +31,29 @@ ignore-patterns=
 
 # 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-allow-list=pydantic
+# run arbitrary code. (This is an alternative name to extension-pkg-allow-list
+# for backward compatibility.)
+extension-pkg-whitelist=pydantic
 
 # Return non-zero exit code if any of these messages/categories are detected,
 # even if score is above --fail-under value. Syntax same as enable. Messages
 # specified are enabled, while categories only check already-enabled messages.
 fail-on=
 
-# Specify a score threshold to be exceeded before program exits with error.
+# Specify a score threshold under which the program will exit with error.
 fail-under=10
 
 # Interpret the stdin as a python script, whose filename needs to be passed as
 # the module_or_package argument.
 #from-stdin=
 
 # Files or directories to be skipped. They should be base names, not paths.
-ignore=CVS,.venv,.build,cdk.out
+ignore=CVS,.venv,.build
 
-# Add files or directories matching the regex patterns to the ignore-list. The
-# regex matches against paths and can be in Posix or Windows format.
+# Add files or directories matching the regular expressions patterns to the
+# ignore-list. The regex matches against paths and can be in Posix or Windows
+# format. Because '\\' represents the directory delimiter on Windows systems,
+# it can't be used as an escape character.
 ignore-paths=
 
 # List of module names for which member attributes should not be checked
@@ -54,11 +64,33 @@ ignored-modules=
 
 # Python code to execute, usually for sys.path manipulation such as
 # pygtk.require().
-init-hook="from pathlib import Path; import os, sys, git; root_dir = Path(git.Repo(os.getcwd(), search_parent_directories=True).working_tree_dir); sys.path.append(root_dir)"
+init-hook="from pathlib import Path; import os, sys; root_dir = Path(os.getcwd()); sys.path.insert(0,str(root_dir));"
+# To troubleshoot import issue with pylint, add this to the end of init-hook: ";print(os.getcwd()); print(sys.path)"
 
 # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the
-# number of processors available to use.
-jobs=2
+# number of processors available to use, and will cap the count on Windows to
+# avoid hangs.
+jobs=4
+
+# Discover python modules and packages in the file system subtree.
+recursive=yes
+
+# Add paths to the list of the source roots. Supports globbing patterns. The
+# source root is an absolute path or a path relative to the current working
+# directory used to determine a package namespace for modules located under the
+# source root.
+source-roots=
+
+# 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
+
+# In verbose mode, extra non-checker-related info will be displayed.
+#verbose=
 
 # Control the amount of potential inferred values when inferring a single
 # object. This can help the performance when dealing with large functions or
@@ -67,7 +99,7 @@ limit-inference-results=100
 
 # List of plugins (as comma separated values of python module names) to load,
 # usually to register additional checkers.
-load-plugins=pylint.extensions.no_self_use
+load-plugins=
 
 # Pickle collected data for later comparisons.
 persistent=yes
@@ -76,20 +108,6 @@ persistent=yes
 # the version used to run pylint.
 py-version=3.8
 
-# Discover python modules and packages in the file system subtree.
-recursive=yes
-
-# 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
-
-# In verbose mode, extra non-checker-related info will be displayed.
-#verbose=
-
 
 [MESSAGES CONTROL]
 
@@ -107,35 +125,26 @@ confidence=
 # --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=file-ignored,
-        wrong-import-position,
-        global-statement,
-        too-few-public-methods,
-        locally-disabled,
-        c-extension-no-member,
-        suppressed-message,
-        cell-var-from-loop,
-        use-symbolic-message-instead,
-        missing-class-docstring,
-        missing-function-docstring,
-        missing-module-docstring,
-        redefined-outer-name,
-        bad-inline-option,
-        useless-suppression,
-        raw-checker-failed,
-        duplicate-code,
-        wrong-import-order,
-        deprecated-pragma,
-        fixme,
-        logging-fstring-interpolation,
-        missing-timeout
+disable=c-extension-no-member,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/information/c-extension-no-member.html
+        wrong-import-position,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/convention/wrong-import-position.html
+        wrong-import-order,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/convention/wrong-import-order.html
+        global-statement,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/global-statement.html
+        too-few-public-methods,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/refactor/too-few-public-methods.html
+        missing-class-docstring,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/convention/missing-class-docstring.html
+        missing-function-docstring,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/convention/missing-function-docstring.html
+        missing-module-docstring,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/convention/missing-module-docstring.html
+        redefined-outer-name,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/redefined-outer-name.html
+        fixme,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/fixme.html
+        broad-exception-caught,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/broad-exception-caught.html
+        broad-exception-raised,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/warning/broad-exception-raised.html
+        duplicate-code,  # https://pylint.readthedocs.io/en/latest/user_guide/messages/refactor/duplicate-code.html
+        logging-fstring-interpolation
 
 # 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=
-
+enable=c-extension-no-member
 
 [REPORTS]
 
@@ -148,10 +157,11 @@ evaluation=max(0, 0 if fatal else 10.0 - ((float(5 * error + warning + refactor
 
 # 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=
+msg-template=
 
-# Set the output format. Available formats are text, parseable, colorized, json
-# and msvs (visual studio). You can also give a reporter class, e.g.
+# Set the output format. Available formats are: text, parseable, colorized,
+# json2 (improved json format), json (old json format) and msvs (visual
+# studio). You can also give a reporter class, e.g.
 # mypackage.mymodule.MyReporterClass.
 output-format=text
 
@@ -173,7 +183,6 @@ max-nested-blocks=5
 # printed.
 never-returning-functions=sys.exit,argparse.parse_error
 
-
 [BASIC]
 
 # Naming style matching correct argument names.
@@ -297,6 +306,10 @@ no-docstring-rgx=^_
 # These decorators are taken in consideration only for invalid-name.
 property-classes=abc.abstractproperty
 
+# Regular expression matching correct type alias names. If left empty, type
+# alias names will be checked with the set naming style.
+#typealias-rgx=
+
 # Regular expression matching correct type variable names. If left empty, type
 # variable names will be checked with the set naming style.
 #typevar-rgx=
@@ -309,7 +322,6 @@ variable-naming-style=snake_case
 # naming style.
 #variable-rgx=
 
-
 [FORMAT]
 
 # Expected format of line ending, e.g. empty (any line ending), LF or CRLF.
@@ -351,11 +363,19 @@ logging-format-style=new
 logging-modules=logging
 
 
+[METHOD_ARGS]
+
+# List of qualified names (i.e., library.method) which require a timeout
+# parameter e.g. 'requests.api.get,requests.api.post'
+timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request
+
+
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
-
+notes=FIXME,
+      XXX,
+      TODO
 
 # Regular expression of note tags to take in consideration.
 notes-rgx=
@@ -384,8 +404,8 @@ min-similarity-lines=4
 # Limits count of emitted suggestions for spelling mistakes.
 max-spelling-suggestions=4
 
-# Spelling dictionary name. Available dictionaries: none. To make it work,
-# install the python-enchant package.
+# Spelling dictionary name. No available dictionaries : You need to install
+# both the python package and the system dependency for enchant to work.
 spelling-dict=
 
 # List of comma separated words that should be considered directives if they
@@ -424,7 +444,7 @@ 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=boto3.*
+generated-members=
 
 # Tells whether to warn about missing members when the owner of the attribute
 # is inferred to be None.
@@ -489,8 +509,7 @@ callbacks=cb_,
 # 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.
+# Argument names that match this expression will be ignored.
 ignored-argument-names=_.*|^ignored_|^unused_
 
 # Tells whether we should check for unused import in __init__ files.
@@ -510,15 +529,12 @@ check-protected-access-in-special-methods=no
 defining-attr-methods=__init__,
                       __new__,
                       setUp,
+                      asyncSetUp,
                       __post_init__
 
 # List of member names, which should be excluded from the protected access
 # warning.
-exclude-protected=_asdict,
-                  _fields,
-                  _replace,
-                  _source,
-                  _make
+exclude-protected=_asdict,_fields,_replace,_source,_make,os._exit
 
 # List of valid names for the first argument in a class method.
 valid-classmethod-first-arg=cls
@@ -538,7 +554,7 @@ exclude-too-few-public-methods=
 ignored-parents=
 
 # Maximum number of arguments for function / method.
-max-args=5
+max-args=10
 
 # Maximum number of attributes for a class (see R0902).
 max-attributes=7
@@ -567,13 +583,15 @@ max-statements=50
 # Minimum number of public methods for a class (see R0903).
 min-public-methods=2
 
-
 [IMPORTS]
 
 # List of modules that can be imported at any level, not just the top level
 # one.
 allow-any-import-level=
 
+# Allow explicit reexports by alias from a package __init__.
+allow-reexport-from-package=no
+
 # Allow wildcard imports from modules that define __all__.
 allow-wildcard-with-all=no
 
@@ -607,4 +625,4 @@ preferred-modules=
 [EXCEPTIONS]
 
 # Exceptions that will emit a warning when caught.
-overgeneral-exceptions=builtins.BaseException
+overgeneral-exceptions=builtins.BaseException,builtins.Exception

LICENSE.txt

@@ -1,5 +1,5 @@
                                  Apache License
-                           Version 2.0, January 2024
+                           Version 2.0, January 2025
                         http://www.apache.org/licenses/
 
    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION