pax_global_header00006660000000000000000000000064147725671600014531gustar00rootroot0000000000000052 comment=5ba080dad7347b180244ef8edf1b0f668fde6199 tiered-debug-1.0.0/000077500000000000000000000000001477256716000140675ustar00rootroot00000000000000tiered-debug-1.0.0/.gitignore000066400000000000000000000065761477256716000160750ustar00rootroot00000000000000# 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/ share/python-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 # Unit test / coverage reports htmlcov/ .tox/ .nox/ .coverage .coverage.* .cache nosetests.xml coverage.xml *.cover *.py,cover .hypothesis/ .pytest_cache/ cover/ cov_html/ # Translations *.mo *.pot # Django stuff: *.log local_settings.py db.sqlite3 db.sqlite3-journal # Flask stuff: instance/ .webassets-cache # Scrapy stuff: .scrapy # Sphinx documentation docs/_build/ # PyBuilder .pybuilder/ target/ # Jupyter Notebook .ipynb_checkpoints # IPython profile_default/ ipython_config.py # pyenv # For a library or package, you might want to ignore these files since the code is # intended to run in multiple environments; otherwise, check them in: # .python-version # pipenv # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. # However, in case of collaboration, if having platform-specific dependencies or dependencies # having no cross-platform support, pipenv may install dependencies that don't work, or not # install all needed dependencies. #Pipfile.lock # UV # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control. # This is especially recommended for binary packages to ensure reproducibility, and is more # commonly ignored for libraries. #uv.lock # poetry # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. # This is especially recommended for binary packages to ensure reproducibility, and is more # commonly ignored for libraries. # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control #poetry.lock # pdm # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. #pdm.lock # pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it # in version control. # https://pdm.fming.dev/latest/usage/project/#working-with-version-control .pdm.toml .pdm-python .pdm-build/ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm __pypackages__/ # Celery stuff celerybeat-schedule celerybeat.pid # SageMath parsed files *.sage.py # Environments .env .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 # Pyre type checker .pyre/ # pytype static type analyzer .pytype/ # Cython debug symbols cython_debug/ # PyCharm # JetBrains specific template is maintained in a separate JetBrains.gitignore that can # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. #.idea/ # Ruff stuff: .ruff_cache/ # PyPI configuration file .pypirc tiered-debug-1.0.0/.vscode/000077500000000000000000000000001477256716000154305ustar00rootroot00000000000000tiered-debug-1.0.0/.vscode/settings.json000066400000000000000000000003241477256716000201620ustar00rootroot00000000000000{ "mypy-type-checker.importStrategy": "useBundled", "black-formatter.importStrategy": "useBundled", "pylint.importStrategy": "useBundled", "pylint.args": [ "--disable=E1205,W1203" ] } tiered-debug-1.0.0/LICENSE000066400000000000000000000261231477256716000151000ustar00rootroot00000000000000 Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2025 Aaron Mildenstein Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. tiered-debug-1.0.0/README.md000066400000000000000000000045161477256716000153540ustar00rootroot00000000000000# tiered-debug [![PyPI - Version](https://img.shields.io/pypi/v/tiered-debug.svg)](https://pypi.org/project/tiered-debug) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tiered-debug.svg)](https://pypi.org/project/tiered-debug) ----- ## Table of Contents - [tiered-debug](#tiered-debug) - [Table of Contents](#table-of-contents) - [Description](#description) - [Installation](#installation) - [Usage](#usage) - [Configuring `stacklevel`](#configuring-stacklevel) - [License](#license) ## Description This module provides a way to enable multiple tiers of debug logging. It's not doing anything fancy. It's just a wrapper around a standard `logger.debug()` call that caps the highest tier of debug logging to a value which can be set via the environment variable `TIERED_DEBUG_LEVEL` at runtime, which has a default of 1, but can be set to any value between 1 and 5. It can also be set interactively via the `set_level()` function. ## Installation ```console pip install tiered-debug ``` ## Usage ```python import tiered_debugging as debug # Set the debug level globally (optional if using environment variable) debug.set_level(3) # Log messages from any module debug.lv1("This will log") # Logs because 1 <= 3 debug.lv3("This will log") # Logs because 3 <= 3 debug.lv4("This won't log") # Doesn't log because 4 > 3 ``` ### Configuring `stacklevel` The `stacklevel` parameter is passed to the `logging.debug()` function as the `stacklevel` argument. The `stacklevel` parameter is the stack level to use for the log message. The default value is 2, which means that the log message will appear to come from the caller of the caller each `lv#` function. In other words, if you call `lv1()` from a function, the log message will appear to come from the caller of that function. If your log formatter is set up to include the module name, function name, and/or line of code in the log message, having the stacklevel properly set will ensure the correct data is displayed. In the event that you use this module as part of another module or class, you may need to increase the `stacklevel` to 3. This can be done using the `set_stacklevel()` function. This will need to be done before any logging takes place. ## License `tiered-debug` is distributed under the terms of the [Apache](LICENSE) license. ©Copyright 2025 Aaron Mildenstein tiered-debug-1.0.0/mypy.ini000066400000000000000000000000651477256716000155670ustar00rootroot00000000000000[mypy] plugins = returns.contrib.mypy.returns_plugin tiered-debug-1.0.0/pylintrc.toml000066400000000000000000000513361477256716000166400ustar00rootroot00000000000000[tool.pylint.main] # 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 = # Clear in-memory caches upon conclusion of linting. Useful if running pylint in # a server-like mode. # clear-cache-post-run = # Always return a 0 (non-error) status code, even if lint errors are found. This # is primarily useful in continuous integration scripts. # exit-zero = # 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 = # 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. (This is an alternative name to extension-pkg-allow-list # for backward compatibility.) # extension-pkg-whitelist = # 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 under which the program will exit with error. fail-under = 10.0 # 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"] # 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 = # 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 = ["^\\.#"] # 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 = # Python code to execute, usually for sys.path manipulation such as # pygtk.require(). # init-hook = # Use multiple processes to speed up Pylint. Specifying 0 will auto-detect the # number of processors available to use, and will cap the count on Windows to # avoid hangs. jobs = 1 # 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 module names) to load, # usually to register additional checkers. # load-plugins = # Pickle collected data for later comparisons. persistent = true # Minimum Python version to use for version dependent checks. Will default to the # version used to run pylint. py-version = "3.12" # Discover python modules and packages in the file system subtree. # recursive = # 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 = true # Allow loading of arbitrary C extensions. Extensions are imported into the # active Python interpreter and may run arbitrary code. # unsafe-load-any-extension = [tool.pylint.basic] # Naming style matching correct argument names. argument-naming-style = "snake_case" # Regular expression matching correct argument names. Overrides argument-naming- # style. If left empty, argument names will be checked with the set 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. If left empty, attribute names will be checked with the set naming # style. # attr-rgx = # Bad variable names which should always be refused, separated by a comma. bad-names = ["foo", "bar", "baz", "toto", "tutu", "tata"] # Bad variable names regexes, separated by a comma. If names match any regex, # they will always be refused # bad-names-rgxs = # Naming style matching correct class attribute names. class-attribute-naming-style = "any" # Regular expression matching correct class attribute names. Overrides class- # attribute-naming-style. If left empty, class attribute names will be checked # with the set naming style. # class-attribute-rgx = # Naming style matching correct class constant names. class-const-naming-style = "UPPER_CASE" # Regular expression matching correct class constant names. Overrides class- # const-naming-style. If left empty, class constant names will be checked with # the set naming style. # class-const-rgx = # Naming style matching correct class names. class-naming-style = "PascalCase" # Regular expression matching correct class names. Overrides class-naming-style. # If left empty, class names will be checked with the set 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. If left empty, constant names will be checked with the set 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. If left empty, function names will be checked with the set naming style. # function-rgx = # Good variable names which should always be accepted, separated by a comma. good-names = ["i", "j", "k", "ex", "Run", "_"] # Good variable names regexes, separated by a comma. If names match any regex, # they will always be accepted # good-names-rgxs = # Include a hint for the correct naming format with invalid-name. # include-naming-hint = # Naming style matching correct inline iteration names. inlinevar-naming-style = "any" # Regular expression matching correct inline iteration names. Overrides # inlinevar-naming-style. If left empty, inline iteration names will be checked # with the set 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. If left empty, method names will be checked with the set 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. If left empty, module names will be checked with the set 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"] # 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 = # Naming style matching correct variable names. variable-naming-style = "snake_case" # Regular expression matching correct variable names. Overrides variable-naming- # style. If left empty, variable names will be checked with the set naming style. # variable-rgx = [tool.pylint.classes] # Warn about protected attribute access inside special methods # check-protected-access-in-special-methods = # List of method names used to declare (i.e. assign) instance attributes. 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", "os._exit"] # 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 = ["mcs"] [tool.pylint.design] # List of regular expressions of class ancestor names to ignore when counting # public methods (see R0903) # exclude-too-few-public-methods = # List of qualified class names to ignore when counting class parents (see R0901) # ignored-parents = # Maximum number of arguments for function / method. max-args = 5 # Maximum number of attributes for a class (see R0902). max-attributes = 7 # Maximum number of boolean expressions in an if statement (see R0916). max-bool-expr = 5 # 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 = 6 # 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 [tool.pylint.exceptions] # Exceptions that will emit a warning when caught. overgeneral-exceptions = ["builtins.BaseException", "builtins.Exception"] [tool.pylint.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*(# )??$" # 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 = 88 # Maximum number of lines in a module. max-module-lines = 1000 # Allow the body of a class to be on the same line as the declaration if body # contains single statement. # single-line-class-stmt = # Allow the body of an if to be on the same line as the test if there is no else. # single-line-if-stmt = [tool.pylint.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 = # Allow wildcard imports from modules that define __all__. # allow-wildcard-with-all = # Deprecated modules which should not be used, separated by a comma. # deprecated-modules = # Output a graph (.gv or any supported image format) of external dependencies to # the given file (report RP0402 must not be disabled). # ext-import-graph = # Output a graph (.gv or any supported image format) of all (i.e. internal and # external) dependencies to the given file (report RP0402 must not be disabled). # import-graph = # Output a graph (.gv or any supported image format) of internal dependencies to # 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"] # Couples of modules and preferred modules, separated by a comma. # preferred-modules = [tool.pylint.logging] # The type of string formatting that logging methods do. `old` means using % # formatting, `new` is for `{}` formatting. logging-format-style = "old" # Logging modules to check that the string format arguments are in logging # function parameter format. logging-modules = ["logging"] [tool.pylint."messages control"] # Only show warnings with the listed confidence levels. Leave empty to show all. # Valid levels: HIGH, CONTROL_FLOW, INFERENCE, INFERENCE_FAILURE, UNDEFINED. confidence = ["HIGH", "CONTROL_FLOW", "INFERENCE", "INFERENCE_FAILURE", "UNDEFINED"] # 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 re-enable 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 = ["raw-checker-failed", "bad-inline-option", "locally-disabled", "file-ignored", "suppressed-message", "useless-suppression", "deprecated-pragma", "use-symbolic-message-instead", "use-implicit-booleaness-not-comparison-to-string", "use-implicit-booleaness-not-comparison-to-zero"] # 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 = [tool.pylint.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"] [tool.pylint.miscellaneous] # List of note tags to take in consideration, separated by a comma. notes = ["FIXME", "XXX", "TODO"] # Regular expression of note tags to take in consideration. # notes-rgx = [tool.pylint.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", "argparse.parse_error"] # Let 'consider-using-join' be raised when the separator to join on would be non- # empty (resulting in expected fixes of the type: ``"- " + " - ".join(items)``) suggest-join-with-non-empty-separator = true [tool.pylint.reports] # Python expression which should return a score less than or equal to 10. You # have access to the variables 'fatal', 'error', 'warning', 'refactor', # 'convention', and 'info' which contain the number of messages in each category, # as well as 'statement' which is the total number of statements analyzed. This # score is used by the global evaluation report (RP0004). evaluation = "max(0, 0 if fatal else 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 = # 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 = # Tells whether to display a full report or only the messages. # reports = # Activate the evaluation score. score = true [tool.pylint.similarities] # Comments are removed from the similarity computation ignore-comments = true # Docstrings are removed from the similarity computation ignore-docstrings = true # Imports are removed from the similarity computation ignore-imports = true # Signatures are removed from the similarity computation ignore-signatures = true # Minimum lines number of a similarity. min-similarity-lines = 4 [tool.pylint.spelling] # Limits count of emitted suggestions for spelling mistakes. max-spelling-suggestions = 4 # 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 # appear at the beginning of a comment and should not be checked. spelling-ignore-comment-directives = "fmt: on,fmt: off,noqa:,noqa,nosec,isort:skip,mypy:" # List of comma separated words that should not be checked. # spelling-ignore-words = # A path to a file that contains the private dictionary; one word per line. # spelling-private-dict-file = # Tells whether to store unknown words to the private dictionary (see the # --spelling-private-dict-file option) instead of raising a message. # spelling-store-unknown-words = [tool.pylint.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 # class is considered mixin if its name matches the mixin-class-rgx option. # Tells whether to warn about missing members when the owner of the attribute is # inferred to be None. ignore-none = true # 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 = true # List of symbolic message names to ignore for Mixin members. ignored-checks-for-mixins = ["no-member", "not-async-context-manager", "not-context-manager", "attribute-defined-outside-init"] # 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", "argparse.Namespace"] # 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 = true # 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 # Regex pattern to define which classes are considered mixins. mixin-class-rgx = ".*[Mm]ixin" # List of decorators that change the signature of a decorated function. # signature-mutators = [tool.pylint.variables] # List of additional names supposed to be defined in builtins. Remember that you # should avoid defining new builtins when possible. # additional-builtins = # Tells whether unused global variables should be treated as a violation. allow-global-unused-variables = true # List of names allowed to shadow builtins # allowed-redefined-builtins = # 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. ignored-argument-names = "_.*|^ignored_|^unused_" # Tells whether we should check for unused import in __init__ files. # init-import = # List of qualified module names which can have objects that can redefine # builtins. redefining-builtins-modules = ["six.moves", "past.builtins", "future.builtins", "builtins", "io"] tiered-debug-1.0.0/pyproject.toml000066400000000000000000000050051477256716000170030ustar00rootroot00000000000000[build-system] requires = ["hatchling"] build-backend = "hatchling.build" [project] name = "tiered-debug" dynamic = ["version"] description = 'A Python logging helper module that allows multiple levels of debug logging' readme = "README.md" requires-python = ">=3.8" license = { text='Apache-2.0' } keywords = ['debug', 'logging', 'tiered-debug'] authors = [ { name = "Aaron Mildenstein", email = "aaron@mildensteins.com" }, ] classifiers = [ "Development Status :: 4 - Beta", "Programming Language :: Python", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", "Programming Language :: Python :: 3.13", ] dependencies = [] [project.optional-dependencies] test = [ 'pytest>=7.2.1', 'pytest-cov', ] [project.urls] Documentation = "https://github.com/untergeek/tiered-debug#readme" Issues = "https://github.com/untergeek/tiered-debug/issues" Source = "https://github.com/untergeek/tiered-debug" [tool.hatch.build.targets.sdist] exclude = [ 'dist', 'docs', 'tests', 'pytest.ini', ] [tool.hatch.version] path = "src/tiered_debug/__init__.py" [tool.hatch.envs.test] dependencies = [ 'pytest >=7.2.1', 'pytest-cov', ] # Test environment [[tool.hatch.envs.test.matrix]] python = ['3.8', '3.9', '3.10', '3.11', '3.12', '3.13'] [tool.hatch.envs.test.scripts] test = 'pytest' test-cov = 'pytest --cov=tiered_debug' cov-report = 'pytest --cov=tiered_debug --cov-report html:cov_html' [tool.hatch.envs.types] extra-dependencies = [ "mypy>=1.0.0", ] [tool.hatch.envs.types.scripts] check = "mypy --install-types --non-interactive {args:src/tiered_debug tests}" [tool.coverage.run] source_pkgs = ["tiered_debug"] branch = true parallel = true omit = [ "src/tiered_debug/__init__.py", ] [tool.coverage.paths] tiered_debug = ["src/tiered_debug", "*/tiered-debug/src/tiered_debug"] tests = ["tests", "*/tiered-debug/tests"] [tool.coverage.report] exclude_lines = [ "no cov", "if __name__ == .__main__.:", "if TYPE_CHECKING:", ] [tool.black] target-version = ['py38'] line-length = 88 skip-string-normalization = false include = '\.pyi?$' [tool.pylint.format] max-line-length = "88" [tool.pytest.ini_options] pythonpath = ['.', 'src/tiered_debug'] minversion = '7.2' addopts = '-ra -q' testpaths = ['tests'] # Lint environment [tool.hatch.envs.lint.scripts] run-black = 'black --quiet --check --diff {args:.}' python = ['run-black'] all = ['python']tiered-debug-1.0.0/pytest.ini000066400000000000000000000002611477256716000161170ustar00rootroot00000000000000[pytest] log_cli=false log_format = %(asctime)s %(levelname)-9s %(name)22s %(funcName)22s:%(lineno)-4d %(message)s filterwarnings = error ignore:Unknown\ config\ option tiered-debug-1.0.0/src/000077500000000000000000000000001477256716000146565ustar00rootroot00000000000000tiered-debug-1.0.0/src/tiered_debug/000077500000000000000000000000001477256716000173005ustar00rootroot00000000000000tiered-debug-1.0.0/src/tiered_debug/__init__.py000066400000000000000000000003111477256716000214040ustar00rootroot00000000000000"""Tiered Debugging Module""" from ._base import set_level, set_stacklevel, lv1, lv2, lv3, lv4, lv5 __all__ = ["set_level", "set_stacklevel", "lv1", "lv2", "lv3", "lv4", "lv5"] __version__ = "1.0.0" tiered-debug-1.0.0/src/tiered_debug/_base.py000066400000000000000000000103631477256716000207260ustar00rootroot00000000000000"""Module with functions to log to multiple tiered debugging levels. This module provides a way to enable multiple tiers of debug logging. It's not doing anything fancy, just a wrapper around a standard ``logger.debug()`` call that caps the highest tier of debug logging to the value of ``_level`` which can be set via the environment variable ``TIERED_DEBUG_LEVEL`` at runtime, with a built-in default of 1. It can be set to a value between 1 and 5. It can also be set interactively via the ``set_level()`` function. For example: .. code-block: python import tiered_debugging as debug # Set the debug level globally (optional if using environment variable) debug.set_level(3) # Log messages from any module debug.lv1("This will log") # Logs because 1 <= 3 debug.lv3("This will log") # Logs because 3 <= 3 debug.lv4("This won't log") # Doesn't log because 4 > 3 The ``stacklevel`` parameter is passed to the :py:func:`logging.debug()` function as the `stacklevel` argument. The ``stacklevel`` parameter is the stack level to use for the log message. The default value is 2, which means that the log message will appear to come from the caller of the caller each ``lv#`` function. In other words, if you call ``lv1()`` from a function, the log message will appear to come from the caller of that function. If your log formatter is set up to include the module name, function name, and/or line of code in the log message, having the stacklevel properly set will ensure the correct data is displayed. In the event that you use this module as part of another module or class, you may need to increase the ``stacklevel`` to 3. This can be done using the ``set_stacklevel()`` function. This will need to be done before any logging takes place. """ # pylint: disable=C0103,W0603 import typing as t from os import environ import logging import inspect DebugLevel = t.Literal[1, 2, 3, 4, 5] logger = logging.getLogger(__name__) ENVVAR = "TIERED_DEBUG_LEVEL" # Initialize global variables _level and _stacklevel _level = 1 _stacklevel = 2 # Check if the environment variable is set and is a valid integer env_level = environ.get(ENVVAR) if env_level is not None: try: _level = int(env_level) if not 1 <= _level <= 5: _level = 1 except ValueError: _level = 1 def set_level(level: DebugLevel) -> None: """Set the global value for _level. :param level: The debug level (1-5). :type level: DebugLevel :raises ValueError: If level is not between 1 and 5. """ global _level if not 1 <= level <= 5: raise ValueError("Debug level must be between 1 and 5") _level = level def set_stacklevel(level: int) -> None: """Set the global value for _stacklevel. :param level: The stacklevel to use for the log message. :type level: int :raises ValueError: If level is not between 1 and 3. """ global _stacklevel if not 1 <= level <= 3: raise ValueError("stacklevel must be between 1 and 3") _stacklevel = level def _get_logger_name(frame) -> str: """Get the module name from the frame.""" mod = inspect.getmodule(frame[0]) if mod is None: return "unknown" return mod.__name__ def lv1(msg: str) -> None: """Log a debug message at level 1.""" # No condition here because this is the default level logger.name = _get_logger_name(inspect.stack()[1]) logger.debug(f"DEBUG1 {msg}", stacklevel=_stacklevel) def lv2(msg: str) -> None: """Log a debug message at level 2.""" if 2 <= _level: logger.name = _get_logger_name(inspect.stack()[1]) logger.debug(f"DEBUG2 {msg}", stacklevel=_stacklevel) def lv3(msg: str) -> None: """Log a debug message at level 3.""" if 3 <= _level: logger.name = _get_logger_name(inspect.stack()[1]) logger.debug(f"DEBUG3 {msg}", stacklevel=_stacklevel) def lv4(msg: str) -> None: """Log a debug message at level 4.""" if 4 <= _level: logger.name = _get_logger_name(inspect.stack()[1]) logger.debug(f"DEBUG4 {msg}", stacklevel=_stacklevel) def lv5(msg: str) -> None: """Log a debug message at level 5.""" if 5 <= _level: logger.name = _get_logger_name(inspect.stack()[1]) logger.debug(f"DEBUG5 {msg}", stacklevel=_stacklevel) tiered-debug-1.0.0/src/tiered_debug/py.typed000066400000000000000000000000001477256716000207650ustar00rootroot00000000000000tiered-debug-1.0.0/tests/000077500000000000000000000000001477256716000152315ustar00rootroot00000000000000tiered-debug-1.0.0/tests/__init__.py000066400000000000000000000001631477256716000173420ustar00rootroot00000000000000# SPDX-FileCopyrightText: 2025-present Aaron Mildenstein # # SPDX-License-Identifier: MIT tiered-debug-1.0.0/tests/test_base.py000066400000000000000000000114231477256716000175550ustar00rootroot00000000000000"""Unit tests for the base module.""" import logging import importlib # from os import environ import pytest from tiered_debug import set_level, set_stacklevel, lv1, lv2, lv3, lv4, lv5 import tiered_debug._base as base ENVVAR = "TIERED_DEBUG_LEVEL" # Fixture to reset global state before each test @pytest.fixture(autouse=True) def reset_state(): """ Reset the global _level and _stacklevel to their default values before each test. """ base._level = 1 base._stacklevel = 2 # Tests for set_level def test_set_level_valid(): """Test that set_level sets _level correctly for valid inputs.""" set_level(1) assert base._level == 1 set_level(3) assert base._level == 3 set_level(5) assert base._level == 5 def test_set_level_invalid(): """Test that set_level raises ValueError for invalid inputs.""" with pytest.raises(ValueError, match="Debug level must be between 1 and 5"): set_level(0) with pytest.raises(ValueError, match="Debug level must be between 1 and 5"): set_level(6) # Tests for set_stacklevel def test_set_stacklevel_valid(): """Test that set_stacklevel sets _stacklevel correctly for valid inputs.""" set_stacklevel(1) assert base._stacklevel == 1 set_stacklevel(2) assert base._stacklevel == 2 set_stacklevel(3) assert base._stacklevel == 3 def test_set_stacklevel_invalid(): """Test that set_stacklevel raises ValueError for invalid inputs.""" with pytest.raises(ValueError, match="stacklevel must be between 1 and 3"): set_stacklevel(0) with pytest.raises(ValueError, match="stacklevel must be between 1 and 3"): set_stacklevel(4) # Tests for initialization based on environment variable def test_initial_level_from_env(monkeypatch): """Test that _level is set from a valid environment variable.""" monkeypatch.setenv(ENVVAR, "4") importlib.reload(base) assert base._level == 4 def test_initial_level_invalid_env(monkeypatch): """Test that _level defaults to 1 with an invalid environment variable.""" monkeypatch.setenv(ENVVAR, "invalid") importlib.reload(base) assert base._level == 1 def test_initial_level_out_of_range_env(monkeypatch): """Test that _level defaults to 1 when environment variable is out of range.""" monkeypatch.setenv(ENVVAR, "6") importlib.reload(base) assert base._level == 1 monkeypatch.setenv(ENVVAR, "0") importlib.reload(base) assert base._level == 1 def test_initial_level_not_set(monkeypatch): """Test that _level defaults to 1 when environment variable is not set.""" monkeypatch.delenv(ENVVAR, raising=False) importlib.reload(base) assert base._level == 1 # Tests for logging functions using parametrize @pytest.mark.parametrize( "level, should_log", [ (1, True), (2, True), (3, True), (4, True), (5, True), ], ) def test_lv1_logs(caplog, level, should_log): """Test that lv1 logs messages when _level >= 1.""" set_level(level) with caplog.at_level(logging.DEBUG): lv1("Test message") assert ("DEBUG1 Test message" in caplog.text) == should_log @pytest.mark.parametrize( "level, should_log", [ (1, False), (2, True), (3, True), (4, True), (5, True), ], ) def test_lv2_logs(caplog, level, should_log): """Test that lv2 logs messages when _level >= 2.""" set_level(level) with caplog.at_level(logging.DEBUG): lv2("Test message") assert ("DEBUG2 Test message" in caplog.text) == should_log @pytest.mark.parametrize( "level, should_log", [ (1, False), (2, False), (3, True), (4, True), (5, True), ], ) def test_lv3_logs(caplog, level, should_log): """Test that lv3 logs messages when _level >= 3.""" set_level(level) with caplog.at_level(logging.DEBUG): lv3("Test message") assert ("DEBUG3 Test message" in caplog.text) == should_log @pytest.mark.parametrize( "level, should_log", [ (1, False), (2, False), (3, False), (4, True), (5, True), ], ) def test_lv4_logs(caplog, level, should_log): """Test that lv4 logs messages when _level >= 4.""" set_level(level) with caplog.at_level(logging.DEBUG): lv4("Test message") assert ("DEBUG4 Test message" in caplog.text) == should_log @pytest.mark.parametrize( "level, should_log", [ (1, False), (2, False), (3, False), (4, False), (5, True), ], ) def test_lv5_logs(caplog, level, should_log): """Test that lv5 logs messages when _level >= 5.""" set_level(level) with caplog.at_level(logging.DEBUG): lv5("Test message") assert ("DEBUG5 Test message" in caplog.text) == should_log