rt 3.1.3__tar.gz → 3.2.0__tar.gz

{rt-3.1.3 → rt-3.2.0}/.editorconfig

@@ -8,7 +8,7 @@ indent_style = space
 [{*.pyw,*.py}]
 indent_size = 4
 tab_width = 4
-max_line_length = 240
+max_line_length = 140
 ij_continuation_indent_size = 4
 ij_python_blank_line_at_file_end = true
 

{rt-3.1.3 → rt-3.2.0}/CHANGELOG.md

@@ -3,6 +3,14 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [v3.2.0], 2024-09-06
+## Added
+- Added option for custom list of fields to be populated for search "query_format" param to avoid unnecessary round trips to get fields like Told, Starts, Resolved, etc by returning the required fields during search. (see #97 @nerdfirefighter)
+
+## [v3.1.4], 2024-02-16
+### Fixes
+- Add a workaround for a breaking change introduced in RT5.0.5 which returns undefined pages variable for non-superusers (see #93 #94).
+
 ## [v3.1.3], 2023-10-10
 ### Fixes
 - Fix an issue where no e-mail was sent on ticket creation due to suggesting to use **Requestors** instead of **Requestor** (https://github.com/python-rt/python-rt/pull/92).

{rt-3.1.3 → rt-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: rt
-Version: 3.1.3
+Version: 3.2.0
 Summary: Python interface to Request Tracker API
 Author-email: Georges Toth <georges.toth@govcert.etat.lu>
 License: GNU General Public License v3 (GPLv3)
@@ -31,17 +31,11 @@ Requires-Dist: sphinx-rtd-theme; extra == "docs"
 Requires-Dist: furo; extra == "docs"
 Requires-Dist: sphinx-copybutton; extra == "docs"
 Provides-Extra: dev
-Requires-Dist: pycodestyle; extra == "dev"
-Requires-Dist: pylint; extra == "dev"
 Requires-Dist: mypy; extra == "dev"
-Requires-Dist: flake8; extra == "dev"
-Requires-Dist: flake8-bandit; extra == "dev"
-Requires-Dist: flake8-comprehensions; extra == "dev"
-Requires-Dist: flake8-docstrings; extra == "dev"
-Requires-Dist: pep8-naming; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
 Requires-Dist: types-requests; extra == "dev"
 Requires-Dist: codespell; extra == "dev"
-Requires-Dist: ruff; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Requires-Dist: pytest-asyncio; extra == "test"

{rt-3.1.3 → rt-3.2.0}/doc/changelog.rst

@@ -1,6 +1,18 @@
 Change Log
 ==========
 
+Version 3.2.0 (2024-09-06)
+----------------------------
+Added
+^^^^^
+- Added option for custom list of fields to be populated for search "query_format" param to avoid unnecessary round trips to get fields like Told, Starts, Resolved, etc by returning the required fields during search. (see #97 @nerdfirefighter)
+
+Version 3.1.4 (2024-02-16)
+----------------------------
+Fixes
+^^^^^
+- Add a workaround for a breaking change introduced in RT5.0.5 which returns undefined pages variable for non-superusers (see #93 #94).
+
 Version 3.1.3 (2023-10-10)
 ----------------------------
 Fixes

rt-3.2.0/noxfile.py

@@ -0,0 +1,16 @@
+"""Used for testing against multiple version of Python."""
+
+import nox
+
+
+@nox.session(python=['3.8', '3.9', '3.10', '3.11'])
+def test_and_typing(session):
+    session.install('.[test,dev]')
+    session.run('pytest', 'tests')
+    session.run('mypy', 'rt')
+
+
+@nox.session()
+def lint(session):
+    session.install(".[test,dev]")
+    session.run('ruff', 'rt')

rt-3.2.0/pyproject.toml

@@ -0,0 +1,190 @@
+[build-system]
+requires = ["setuptools>=65", "setuptools_scm[toml]>=7.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "rt"
+description = "Python interface to Request Tracker API"
+readme = "README.rst"
+license = { text = "GNU General Public License v3 (GPLv3)" }
+authors = [{ name = "Georges Toth", email = "georges.toth@govcert.etat.lu" }]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
+    "Operating System :: POSIX",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">= 3.8"
+dependencies = [
+    "requests",
+    "httpx",
+]
+dynamic = ["version"]
+
+[project.urls]
+Homepage = "https://github.com/python-rt/python-rt"
+Documentation = "https://python-rt.readthedocs.io/"
+Source = "https://github.com/python-rt/python-rt"
+Tracker = "https://github.com/python-rt/python-rt/issues"
+Changelog = "https://github.com/python-rt/python-rt/blob/master/CHANGELOG.md"
+
+[project.optional-dependencies]
+docs = [
+    "sphinx",
+    "sphinx-autodoc-typehints",
+    "sphinx-rtd-theme",
+    "furo",
+    "sphinx-copybutton",
+]
+dev = [
+    "mypy",
+    "ruff",
+    "types-requests",
+    "codespell",
+    "bandit",
+]
+test = [
+    "pytest",
+    "pytest-asyncio",
+    "coverage",
+]
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.packages.find]
+exclude = ["tests"]
+namespaces = false
+
+[tool.pycodestyle]
+filename = "rt/rt.py"
+ignore = "E501, W503, E124, E126"
+
+[tool.setuptools_scm]
+
+[tool.mypy]
+show_error_codes = true
+show_error_context = true
+show_column_numbers = true
+ignore_missing_imports = true
+disallow_incomplete_defs = true
+disallow_untyped_defs = true
+disallow_untyped_calls = false
+warn_no_return = true
+warn_redundant_casts = true
+warn_unused_ignores = true
+strict_optional = true
+check_untyped_defs = false
+
+files = [
+    "rt/**/*.py"
+]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+testpaths = [
+    "tests"
+]
+
+[tool.ruff]
+line-length = 140
+indent-width = 4
+target-version = "py38"
+
+[tool.ruff.lint]
+select = [
+    "E", # pycodestyle errors
+    "W", # pycodestyle warnings
+    "F", # pyflakes
+    "I", # isort
+    "C", # flake8-comprehensions
+    "B", # flake8-bugbear
+    "D", # pydocstyle
+    "N", # pep8-naming
+    "UP", # pyupgrade
+    "YTT", # flake8-2020
+    "ANN", # flake8-annotations
+    "ASYNC", # flake8-async
+    "S", # flake8-bandit
+    "BLE", # flake8-blind-except
+    "B", # flake8-bugbear
+    "A", # flake8-builtins
+    "COM", # flake8-commas
+    "C4", # flake8-comprehensions
+    "DTZ", # flake8-datetimez
+    "EM103", # flake8-errmsg - dot-format-in-exception
+    "EXE", # flake8-executable
+    "ISC", # flake8-implicit-str-concat
+    "ICN", # flake8-import-conventions
+    "G", # flake8-logging-format
+    "INP", # flake8-no-pep420
+    "PIE", # flake8-pie
+    "T20", # flake8-print
+    "PYI", # flake8-pyi
+    "RSE", # flake8-raise
+    "RET", # flake8-return
+    "SLF", # flake8-self
+    "SLOT", # flake8-slots
+    #    "SIM",  # flake8-simplify
+    "TID", # flake8-tidy-imports
+    "TCH", # flake8-type-checking
+    "PTH", # flake8-use-pathlib
+    "TD", # flake8-todos
+    "FIX", # flake8-fixme
+    "ERA", # eradicate
+    "PL", # Pylint
+    "PLC", # Convention
+    "PLE", # Error
+    "PLR", # Refactor
+    "PLW", # Warning
+    "B904", # reraise-no-cause
+    "FLY", # flynt
+    #    "PERF",  # Perflint
+    "RUF013", # implicit-optional
+]
+unfixable = [
+    'ERA001',
+    'T201', # `print` found
+]
+extend-select = ['Q', 'RUF100', 'C90']
+flake8-quotes = { inline-quotes = 'single', multiline-quotes = 'single' }
+ignore = [
+    "C901", # too complex
+    "E501", # line too long
+    "B008", # do not perform function call in argument defaults
+    "ANN101", # missing-type-self
+    "ANN401", # any-type
+    "ANN002", # missing-type-args
+    "ANN003", # missing-type-kwargs
+    "ANN102", # missing-type-cls
+    "PLR0913", # Too many arguments to function call
+    "PLR0915", # Too many statements
+    "PLR2004", # Magic value used in comparison
+    "PLW0603", # Using the global statement
+    "PLR0912", # Too many branches
+    "COM812", #	missing-trailing-comma
+    "ISC001", # single-line-implicit-string-concatenation
+    "Q001", # bad-quotes-multiline-string
+    "RET504", # Unnecessary assignment before `return` statement
+    "D401", # First line of docstring should be in imperative mood
+    "D205", # 1 blank line required between summary line and description
+]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = [
+    "ANN", # Missing return type annotation
+]
+"rt/rest1.py" = [
+    "N803", # Argument name should be lowercase
+]
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint.pydocstyle]
+convention = "numpy"

{rt-3.1.3 → rt-3.2.0}/rt/exceptions.py

@@ -4,33 +4,32 @@ import typing
 
 
 class RtError(Exception):
-    """ Super class of all Rt Errors """
+    """Super class of all Rt Errors."""
 
 
 class AuthorizationError(RtError):
-    """ Exception raised when module cannot access :term:`API` due to invalid
-    or missing credentials. """
+    """Exception raised when module cannot access :term:`API` due to invalid or missing credentials."""
 
 
 class NotAllowedError(RtError):
-    """ Exception raised when request cannot be finished due to
-    insufficient privileges. """
+    """Exception raised when request cannot be finished due to insufficient privileges."""
 
 
 class UnexpectedResponseError(RtError):
-    """ Exception raised when unexpected HTTP code is received. """
+    """Exception raised when unexpected HTTP code is received."""
 
     def __init__(self, message: str, status_code: typing.Optional[int] = None, response_message: typing.Optional[str] = None) -> None:
-        """ Initialization."""
+        """Initialization."""
         super().__init__(message)
         self.status_code = status_code
         self.response_message = response_message
 
 
 class UnexpectedMessageFormatError(RtError):
-    """ Exception raised when response has bad status code (not the HTTP code,
+    """Exception raised when response has bad status code (not the HTTP code,
     but code in the first line of the body as 200 in `RT/4.0.7 200 Ok`)
-    or message parsing fails because of unexpected format. """
+    or message parsing fails because of unexpected format.
+    """
 
 
 class NotFoundError(RtError):
@@ -38,22 +37,22 @@ class NotFoundError(RtError):
 
 
 class APISyntaxError(RtError):
-    """ Exception raised when syntax error is received. """
+    """Exception raised when syntax error is received."""
 
 
 class InvalidUseError(RtError):
-    """ Exception raised when API method is not used correctly. """
+    """Exception raised when API method is not used correctly."""
 
 
 class BadRequestError(RtError):
-    """ Exception raised when HTTP code 400 (Bad Request) is received. """
+    """Exception raised when HTTP code 400 (Bad Request) is received."""
 
 
 class ConnectionError(RtError):
-    """ Encapsulation of various exceptions indicating network problems. """
+    """Encapsulation of various exceptions indicating network problems."""
 
     def __init__(self, message: str, cause: Exception) -> None:
-        """ Initialization of exception extended by cause parameter.
+        """Initialization of exception extended by cause parameter.
 
         :keyword message: Exception details
         :keyword cause: Cause exception
@@ -63,4 +62,4 @@ class ConnectionError(RtError):
 
 
 class InvalidQueryError(RtError):
-    """ Exception raised when attempting to search RT with an invalid raw query. """
+    """Exception raised when attempting to search RT with an invalid raw query."""