diff --git a/.github/workflows/develop.yml b/.github/workflows/develop.yml new file mode 100644 index 0000000..d0d66c2 --- /dev/null +++ b/.github/workflows/develop.yml @@ -0,0 +1,66 @@ +name: Relativedleta tests + +on: [push] + +jobs: + build: + + runs-on: ubuntu-latest + services: + mysql: + image: mysql:5.7 + env: + DB_USER: root + DB_PASSWORD: root + DB_HOST: localhost + DB_PORT: 3306 + DB_DATABASE: relativedeltafield + MYSQL_ROOT_PASSWORD: root + ports: + - 3306 + postgres: + image: postgres:11.6 + env: + PGUSER: postgres + PGPASSWORD: postgres + PGDATABASE: relativedeltafield + PGHOST: localhost + ports: + - 5432:5432 + strategy: + matrix: + python-version: ["3.9", "3.10"] + steps: + - name: Start Postgres + run: | + sudo /etc/init.d/postgresql start || journalctl -xe + - name: Start MySQL + run: | + sudo /etc/init.d/mysql start || journalctl -xe + - uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python-version }} + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install tox tox-gh-actions + - name: Lint with 'flake8' + run: | + pip install flake8 + # stop the build if there are Python syntax errors or undefined names + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 src --count --show-source --statistics --exit-zero --max-complexity=20 + - name: Test with pytest + run: | + tox + env: + PGUSER: postgres + PGPASSWORD: postgres + PGDATABASE: relativedeltafield + PGHOST: localhost + MYSQL_USER: root + MYSQL_PASSWORD: root + MYSQL_HOST: localhost + MYSQL_PORT: 3306 diff --git a/.gitignore b/.gitignore index a125ac3..2bfaad9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -.* +#.* !.gitignore !.*.example !.travis.yml @@ -7,7 +7,7 @@ !.bumpversion.cfg ~build/ - +.coverage *.egg-info *.sqlite diff --git a/.pylintrc b/.pylintrc new file mode 100644 index 0000000..10a4f1c --- /dev/null +++ b/.pylintrc @@ -0,0 +1,613 @@ +[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=no + +# Load and enable all available extensions. Use --list-extensions to see a list +# all available extensions. +#enable-all-extensions= + +# 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. +# 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 to be exceeded before program exits 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 + +# 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. +ignore-paths= + +# 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=^\.# + +# 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=yes + +# Minimum Python version to use for version dependent checks. Will default to +# the version used to run pylint. +py-version=3.10 + +# Discover python modules and packages in the file system subtree. +recursive=no + +# 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= + + +[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, json +# and msvs (visual studio). You can also give a reporter class, e.g. +# mypackage.mymodule.MyReporterClass. +output-format=colorized + +# Tells whether to display a full report or only the messages. +reports=yes + +# Activate the evaluation score. +score=yes + + +[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 + +# 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 + + +[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=e, + i, + j, + k, + ex, + Run, + _, + v, + m + +# 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=no + +# 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 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= + + +[SIMILARITIES] + +# Comments are removed from the similarity computation +ignore-comments=yes + +# Docstrings are removed from the similarity computation +ignore-docstrings=yes + +# Imports are removed from the similarity computation +ignore-imports=yes + +# Signatures are removed from the similarity computation +ignore-signatures=yes + +# Minimum lines number of a similarity. +min-similarity-lines=4 + + +[CLASSES] + +# Warn about protected attribute access inside special methods +check-protected-access-in-special-methods=no + +# List of method names used to declare (i.e. assign) instance attributes. +defining-attr-methods=__init__, + __new__, + setUp, + __post_init__ + +# 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 + + +[SPELLING] + +# 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-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=no + + +[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=119 + +# 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=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 + + +[IMPORTS] + +# List of modules that can be imported at any level, not just the top level +# one. +allow-any-import-level= + +# Allow wildcard imports from modules that define __all__. +allow-wildcard-with-all=no + +# 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= + + +[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 + + +[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= + + +[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 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 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=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 + +# 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= + + +[EXCEPTIONS] + +# Exceptions that will emit a warning when caught. +overgeneral-exceptions=BaseException, + Exception + + +[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 + + +[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 + + +[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=yes + +# 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. 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 + + +[STRING] + +# This flag controls whether inconsistent-quotes generates a warning when the +# character used as a quote delimiter is used inconsistently within a module. +check-quote-consistency=no + +# This flag controls whether the implicit-str-concat should generate a warning +# on implicit string concatenation in sequences defined over several lines. +check-str-concat-over-line-jumps=no diff --git a/setup.py b/setup.py index ef8755a..ea8a4a4 100755 --- a/setup.py +++ b/setup.py @@ -1,6 +1,7 @@ #! /usr/bin/env python3 import os + from setuptools import find_packages, setup test_deps = [ @@ -37,22 +38,16 @@ 'Development Status :: 5 - Production/Stable', 'Environment :: Web Environment', 'Framework :: Django', - 'Framework :: Django :: 1.10', - 'Framework :: Django :: 1.11', - 'Framework :: Django :: 2.0', - 'Framework :: Django :: 2.1', - 'Framework :: Django :: 2.2', - 'Framework :: Django :: 3.0', + 'Framework :: Django :: 3.2', + 'Framework :: Django :: 4.0', + 'Framework :: Django :: 4.1', 'Intended Audience :: Developers', 'License :: OSI Approved :: MIT License', 'Operating System :: OS Independent', 'Programming Language :: Python', 'Programming Language :: Python :: 3', - 'Programming Language :: Python :: 3.4', - 'Programming Language :: Python :: 3.5', - 'Programming Language :: Python :: 3.6', - 'Programming Language :: Python :: 3.7', - 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: 3.10', 'Topic :: Database', 'Topic :: Internet :: WWW/HTTP', 'Topic :: Internet :: WWW/HTTP :: Dynamic Content', @@ -60,7 +55,7 @@ 'Topic :: Software Development :: Libraries :: Python Modules', ], install_requires=[ - 'Django >= 1.10, < 4.0', + 'Django >= 3.2', 'python-dateutil >= 2.6.0', ], tests_require=test_deps, diff --git a/src/relativedeltafield/__init__.py b/src/relativedeltafield/__init__.py index 37068d4..2b8dc1c 100644 --- a/src/relativedeltafield/__init__.py +++ b/src/relativedeltafield/__init__.py @@ -1,9 +1,11 @@ +""" .. currentmodule:: relativedelta""" + __version__ = '1.1.2' from django.contrib.admin.options import FORMFIELD_FOR_DBFIELD_DEFAULTS -from .fields import RelativeDeltaField # noqa -from .forms import RelativeDeltaFormField # noqa +from .fields import RelativeDeltaField # noqa +from .forms import RelativeDeltaFormField # noqa FORMFIELD_FOR_DBFIELD_DEFAULTS[RelativeDeltaField] = { 'form_class': RelativeDeltaFormField diff --git a/src/relativedeltafield/fields.py b/src/relativedeltafield/fields.py index 3963b24..054530a 100644 --- a/src/relativedeltafield/fields.py +++ b/src/relativedeltafield/fields.py @@ -1,7 +1,8 @@ +""" .. currentmodule:: relativedelta.fields""" + from django.core.exceptions import ValidationError from django.db import models from django.utils.translation import gettext_lazy as _ - from relativedeltafield.utils import (format_relativedelta, parse_relativedelta, relativedelta_as_csv) @@ -20,7 +21,7 @@ def __get__(self, obj, objtype=None): try: return parse_relativedelta(value) except ValueError as e: - raise ValidationError({self.field.name: e}) + raise ValidationError({self.field.name: e}) from e def __set__(self, obj, value): obj.__dict__[self.field.name] = value @@ -39,46 +40,43 @@ class RelativeDeltaField(models.Field): description = _("RelativeDelta") descriptor_class = RelativeDeltaDescriptor - def get_lookup(self, lookup_name): - ret = super().get_lookup(lookup_name) - return ret - def db_type(self, connection): if connection.vendor == 'postgresql': return 'interval' - else: - return 'varchar(33)' + + return 'varchar(33)' def get_db_prep_save(self, value, connection): if value is None: return None + if connection.vendor == 'postgresql': return super().get_db_prep_save(value, connection) - else: - if isinstance(value, str): # we need to convert it to the non-postgres format - return relativedelta_as_csv(parse_relativedelta(value)) - return relativedelta_as_csv(value) + + if isinstance(value, str): # we need to convert it to the non-postgres format + return relativedelta_as_csv(parse_relativedelta(value)) + return relativedelta_as_csv(value) def to_python(self, value): if value is None: return value try: return parse_relativedelta(value) - except (ValueError, TypeError): + except (ValueError, TypeError) as exc: raise ValidationError( self.error_messages['invalid'], code='invalid', params={'value': value}, - ) + ) from exc def get_db_prep_value(self, value, connection, prepared=False): if value is None: return value - else: - if connection.vendor == 'postgresql': - return format_relativedelta(self.to_python(value)) - else: - return relativedelta_as_csv(self.to_python(value)) + + if connection.vendor == 'postgresql': + return format_relativedelta(self.to_python(value)) + + return relativedelta_as_csv(self.to_python(value)) # This is a bit of a mindfuck. We have to cast the output field # as text to bypass the standard deserialisation of PsycoPg2 to @@ -95,7 +93,7 @@ def get_db_prep_value(self, value, connection, prepared=False): # Django assumes PsycoPg2 returns pre-parsed datetime.timedeltas. def select_format(self, compiler, sql, params): if compiler.connection.vendor == 'postgresql': - fmt = 'to_char(%s, \'PYYYY"Y"MM"M"DD"DT"HH24"H"MI"M"SS.US"S"\')' % sql + fmt = f'to_char({sql}, \'PYYYY"Y"MM"M"DD"DT"HH24"H"MI"M"SS.US"S"\')' else: fmt = sql return fmt, params diff --git a/src/relativedeltafield/forms.py b/src/relativedeltafield/forms.py index ae87f52..5b3a367 100644 --- a/src/relativedeltafield/forms.py +++ b/src/relativedeltafield/forms.py @@ -1,22 +1,40 @@ -from django import forms -from django.core.exceptions import ValidationError +""" .. currentmodule:: relativedelta.forms""" + +from dateutil.relativedelta import relativedelta -from relativedeltafield.utils import parse_relativedelta, format_relativedelta +from django import forms # pylint: disable=import-error +from django.core.exceptions import ValidationError +from relativedeltafield.utils import format_relativedelta, parse_relativedelta class RelativeDeltaFormField(forms.CharField): + """Field for use in Django forms for relative time deltas""" - def prepare_value(self, value): + def prepare_value(self, value: str) -> relativedelta: + """Coerce the value into ISO ISO8601 format""" try: return format_relativedelta(value) - except Exception: + + except Exception: # pylint: disable=W0703 return value - def to_python(self, value): + def to_python(self, value: str) -> relativedelta: + """Coerce the value into a python relativedelta object""" return parse_relativedelta(value) - def clean(self, value): + def clean(self, value: str) -> relativedelta: + """Validate the data + + Raises: + + ValidationError: when the value can not be coerced into ISO8601 + + """ try: return parse_relativedelta(value) - except Exception: - raise ValidationError('Not a valid (extended) ISO8601 interval specification', code='format') + + except Exception as exc: + raise ValidationError( + 'Not a valid (extended) ISO8601 interval specification', + code='format' + ) from exc diff --git a/src/relativedeltafield/utils.py b/src/relativedeltafield/utils.py index 12b61c9..cbe8eb7 100644 --- a/src/relativedeltafield/utils.py +++ b/src/relativedeltafield/utils.py @@ -1,4 +1,7 @@ +""" .. currentmodule:: relativedelta.utils""" + import re +import typing from datetime import timedelta from dateutil.relativedelta import relativedelta @@ -6,7 +9,7 @@ # This is not quite ISO8601, as it allows the SQL/Postgres extension # of allowing a minus sign in the values, and you can mix weeks with # other units (which ISO doesn't allow). -iso8601_duration_re = re.compile( +iso8601_duration_re: re.Pattern = re.compile( r'P' r'(?:(?P-?\d+(?:\.\d+)?)Y)?' r'(?:(?P-?\d+(?:\.\d+)?)M)?' @@ -21,22 +24,35 @@ ) # This is the comma-separated internal value to be used for databases non supporting the interval type natively -iso8601_csv_re = re.compile(r"^(?P^[-\d]\d{4})/(?P[-\d]\d{2})/(?P[-\d]\d{2}) " - r"(?P[-\d]\d{2}):(?P[-\d]\d{2}):(?P[-\d]\d{2})\." - r"(?P[-\d]\d{6})$") +iso8601_csv_re: re.Pattern = re.compile( + r"^(?P^[-\d]\d{4})/(?P[-\d]\d{2})/(?P[-\d]\d{2}) " + r"(?P[-\d]\d{2}):(?P[-\d]\d{2}):(?P[-\d]\d{2})\." + r"(?P[-\d]\d{6})$" +) # Parse ISO8601 timespec -def parse_relativedelta(value): +def parse_relativedelta( + value: typing.Optional[typing.Union[relativedelta, timedelta, str]] +) -> typing.Union[relativedelta, typing.NoReturn]: + """Parses a relative delta, time delta or string into ISO08601 + + Raises: + + ValueError: IS the value is not an ISO08601 spec + """ if value is None or value == '': return None - elif isinstance(value, timedelta): + + if isinstance(value, timedelta): microseconds = value.seconds % 1 * 1e6 + value.microseconds seconds = int(value.seconds) return relativedelta(days=value.days, seconds=seconds, microseconds=microseconds) - elif isinstance(value, relativedelta): + + if isinstance(value, relativedelta): return value.normalized() - elif isinstance(value, str): + + if isinstance(value, str): try: m = iso8601_duration_re.match(value) or iso8601_csv_re.match(value) if m: @@ -49,12 +65,13 @@ def parse_relativedelta(value): else: args[k] = int(v) return relativedelta(**args).normalized() if m else None - except Exception: + except Exception: # pylint: disable=broad-except pass raise ValueError('Not a valid (extended) ISO8601 interval specification') def relativedelta_as_csv(self) -> str: + """TODO: Docstring""" return '%05d/%03d/%03d %03d:%03d:%03d.%07d' % ( self.years, self.months, @@ -66,34 +83,39 @@ def relativedelta_as_csv(self) -> str: ) -# Format ISO8601 timespec -def format_relativedelta(relativedelta): - result_big = '' +def format_relativedelta(relativedelta_: relativedelta) -> str: + """Format ISO8601 timespec""" + result_big: str = '' # TODO: We could always include all components, but that's kind of # ugly, since one second would be formatted as 'P0Y0M0W0DT0M1S' - if relativedelta.years: - result_big += '{}Y'.format(relativedelta.years) - if relativedelta.months: - result_big += '{}M'.format(relativedelta.months) - if relativedelta.days: - result_big += '{}D'.format(relativedelta.days) - - result_small = '' - if relativedelta.hours: - result_small += '{}H'.format(relativedelta.hours) - if relativedelta.minutes: - result_small += '{}M'.format(relativedelta.minutes) + if relativedelta_.years: + result_big += f'{relativedelta_.years}Y' + + if relativedelta_.months: + result_big += f'{relativedelta_.months}M' + + if relativedelta_.days: + result_big += f'{relativedelta_.days}D' + + result_small: str = '' + if relativedelta_.hours: + result_small += f'{relativedelta_.hours}H' + + if relativedelta_.minutes: + result_small += f'{relativedelta_.minutes}M' + # Microseconds is allowed here as a convenience, the user may have # used normalized(), which can result in microseconds - if relativedelta.seconds: - seconds = relativedelta.seconds - if relativedelta.microseconds: - seconds += relativedelta.microseconds / 1000000.0 - result_small += '{}S'.format(seconds) + if relativedelta_.seconds: + seconds: float = relativedelta_.seconds + if relativedelta_.microseconds: + seconds += relativedelta_.microseconds / 1000000.0 + result_small += f'{seconds}S' if len(result_small) > 0: - return 'P{}T{}'.format(result_big, result_small) - elif len(result_big) == 0: + return f'P{result_big}T{result_small}' + + if len(result_big) == 0: return 'P0D' # Doesn't matter much what field is zero, but just 'P' is invalid syntax, and so is '' - else: - return 'P{}'.format(result_big) + + return f'P{result_big}' diff --git a/tests/testproject/requirements.txt b/tests/testproject/requirements.txt index d27cc1f..3c67a25 100644 --- a/tests/testproject/requirements.txt +++ b/tests/testproject/requirements.txt @@ -1,4 +1,4 @@ -Django>=1.10 +Django>=3.2 python-dateutil>=2.6.0 psycopg2-binary>=2.8.6 pytest>=6.0.2 diff --git a/tox.ini b/tox.ini index e36e442..ca64792 100644 --- a/tox.ini +++ b/tox.ini @@ -1,6 +1,10 @@ [tox] -envlist = d{20,21,22,30,31}-py{36,37,38}-{pg,sqlite,mysql} +envlist = d{32,40,41}-py{39,310}-{pg,sqlite,mysql} +[gh-actions] +python = + 3.9: py39 + 3.10: py310 [pytest] python_paths=./tests/testproject/ src @@ -12,7 +16,6 @@ addopts = -rs -p no:xdist -p no:warnings - --reuse-db --tb=short --capture=no --echo-version django @@ -65,11 +68,9 @@ deps = psycopg2-binary mysql: mysqlclient docs: -rdocs/requirements.pip - d20: django>=2.0,<2.1 - d21: django>=2.1,<2.2 - d22: django>=2.2,<2.3 - d30: django==3.0.* - d31: django==3.1.* + d32: django==3.2.* + d40: django==4.0.* + d41: django==4.1.* commands = {posargs:pytest tests -rw --create-db}