diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 641d6fa..9dbf81c 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -35,11 +35,11 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@v2 + uses: actions/checkout@v4 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v1 + uses: github/codeql-action/init@v3 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -50,7 +50,7 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this step fails, then you should remove it and run the build manually (see below) - name: Autobuild - uses: github/codeql-action/autobuild@v1 + uses: github/codeql-action/autobuild@v3 # ℹ️ Command-line programs to run using the OS shell. # 📚 https://git.io/JvXDl @@ -64,4 +64,4 @@ jobs: # make release - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 + uses: github/codeql-action/analyze@v3 diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 924a732..3614ed4 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -7,43 +7,26 @@ on: pull_request: types: [opened, synchronize, reopened] jobs: - check_skip: - runs-on: ubuntu-latest - if: "! contains(github.event.head_commit.message, '[ci skip]')" - steps: - - run: echo "${{ github.event.head_commit.message }}" - test: runs-on: ubuntu-latest strategy: fail-fast: false matrix: - python-version: [3.7, 3.8, 3.9, "3.10"] + python-version: [3.9, "3.10", "3.11", "3.12", "3.13"] steps: - - uses: actions/checkout@v2 - - name: Set up Python ${{ matrix.python-version }} - uses: actions/setup-python@v2 + - uses: actions/checkout@v4 + - name: Install uv + uses: astral-sh/setup-uv@v3 with: - python-version: ${{ matrix.python-version }} - - name: check OS - run: cat /etc/os-release - - name: Install Make - run: | - sudo apt-get update - sudo apt-get install --reinstall make - - name: Upgrade pip - run: python3 -m pip install --upgrade pip - - name: Install Coqpit - run: | - pip install -r requirements_dev.txt - pip install -r requirements.txt - pip install -e . + version: "0.4.21" + enable-cache: true + cache-dependency-glob: "**/pyproject.toml" + - name: Set up Python ${{ matrix.python-version }} + run: uv python install ${{ matrix.python-version }} - name: Lint check run: make lint - name: Unit tests run: make test - name: Test package build - run: | - pip install build - python -m build + run: uv build diff --git a/.github/workflows/pypi-release.yml b/.github/workflows/pypi-release.yml index 85b0c62..cd46b55 100644 --- a/.github/workflows/pypi-release.yml +++ b/.github/workflows/pypi-release.yml @@ -7,31 +7,49 @@ defaults: shell: bash jobs: - build-package: - runs-on: ubuntu-20.04 + build: + runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 - name: Verify tag matches version run: | set -ex - version=$(cat VERSION) + version=$(grep -m 1 version pyproject.toml | grep -P '\d+\.\d+\.\d+' -o) tag="${GITHUB_REF/refs\/tags\/}" if [[ "v$version" != "$tag" ]]; then exit 1 fi - - uses: actions/setup-python@v2 + - name: Install uv + uses: astral-sh/setup-uv@v3 with: - python-version: 3.9 - - run: | - python -m pip install -U pip setuptools twine build - - run: | - python -m build - - name: Setup PyPI config + version: "0.4.21" + enable-cache: true + cache-dependency-glob: "**/pyproject.toml" + - name: Set up Python + run: uv python install + - name: Build sdist and wheel + run: uv build + - name: Test installation of sdist and wheel run: | - cat << EOF > ~/.pypirc - [pypi] - username=__token__ - password=${{ secrets.PYPI_TOKEN }} - EOF - - run: | - twine upload --repository pypi dist/* + uv venv --no-project + uv pip install dist/*.tar.gz + uv pip install dist/*.whl + - uses: actions/upload-artifact@v4 + with: + name: dist + path: dist/coqpit* + publish-artifacts: + runs-on: ubuntu-latest + needs: [build] + environment: + name: release + url: https://pypi.org/p/coqui-tts-coqpit + permissions: + id-token: write + steps: + - uses: actions/download-artifact@v4 + with: + name: "dist" + path: "dist/" + - name: Publish package distributions to PyPI + uses: pypa/gh-action-pypi-publish@release/v1 diff --git a/.pre-commit-2.12.1.pyz b/.pre-commit-2.12.1.pyz deleted file mode 100644 index b24806d..0000000 Binary files a/.pre-commit-2.12.1.pyz and /dev/null differ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index a70572d..727d5cc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,27 +1,14 @@ repos: + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.6.9 + hooks: + - id: ruff + args: [--fix, --exit-non-zero-on-fix] + - id: ruff-format + - repo: 'https://github.com/pre-commit/pre-commit-hooks' - rev: v2.3.0 + rev: v5.0.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - - repo: 'https://github.com/psf/black' - rev: 20.8b1 - hooks: - - id: black - language_version: python3 - - repo: https://github.com/pycqa/isort - rev: 5.8.0 - hooks: - - id: isort - name: isort (python) - - id: isort - name: isort (cython) - types: [cython] - - id: isort - name: isort (pyi) - types: [pyi] - - repo: https://github.com/pycqa/pylint - rev: v2.8.2 - hooks: - - id: pylint diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index 6fb2cf7..0000000 --- a/.pylintrc +++ /dev/null @@ -1,633 +0,0 @@ -[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 under which the program will exit with error. -fail-under=10 - -# Interpret the stdin as a python script, whose filename needs to be passed as -# the module_or_package argument. -#from-stdin= - -# Files or directories to be skipped. They should be base names, not paths. -ignore=CVS - -# 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=yes - -# Minimum Python version to use for version dependent checks. Will default to -# the version used to run pylint. -py-version=3.9 - -# 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= - - -[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=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= - - -[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 - - -[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 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when caught. -overgeneral-exceptions=BaseException, - Exception - - -[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=100 - -# 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= - - -[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 - - -[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, - line-too-long, - missing-function-docstring, - missing-class-docstring, - missing-module-docstring, - too-many-arguments, - too-many-instance-attributes, - useless-option-value, - fixme, - no-member, - too-few-public-methods, - arguments-differ, - too-many-branches, - duplicate-code, - invalid-name, - - -# 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 - - -[METHOD_ARGS] - -# List of qualified names (i.e., library.method) which require a timeout -# parameter e.g. 'requests.api.get,requests.api.post' -timeout-methods=requests.api.delete,requests.api.get,requests.api.head,requests.api.options,requests.api.patch,requests.api.post,requests.api.put,requests.api.request - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -notes=FIXME, - XXX, - TODO - -# Regular expression of note tags to take in consideration. -notes-rgx= - - -[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 - - -[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= - -# Tells whether to display a full report or only the messages. -reports=no - -# Activate the evaluation score. -score=yes - - -[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 - - -[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 - - -[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 - - -[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= - - -[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. -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 diff --git a/LICENSE.txt b/LICENSE.txt index f82557b..d3e759d 100644 --- a/LICENSE.txt +++ b/LICENSE.txt @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Coqui +Copyright (c) 2021 Coqui Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/MANIFEST.in b/MANIFEST.in index 1085f6c..8b8dab6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,7 +1,5 @@ -include VERSION include README.md include LICENSE.txt -include requirements*.txt recursive-include coqpit *.json recursive-include coqpit *.html recursive-include coqpit *.png diff --git a/Makefile b/Makefile index 310adff..0638c4b 100644 --- a/Makefile +++ b/Makefile @@ -1,23 +1,17 @@ .DEFAULT_GOAL := help -.PHONY: style lint install help +.PHONY: lint install help help: @grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' -target_dirs := tests coqpit - - test: ## run tests. - coverage run -m pytest && coverage report --show-missing - -style: ## update code style. - black ${target_dirs} - isort ${target_dirs} + uv run coverage run -m pytest && uv run coverage report --show-missing -lint: ## run pylint linter. - pylint ${target_dirs} +lint: ## run ruff format and lint + uv run pre-commit run --all-files install: ## install 👩‍✈️ Coqpit for development. - pip install -e . + uv sync --all-extras + uv runpre-commit install testlint: test lint diff --git a/README.md b/README.md index a0d997b..762ab5f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,11 @@ # 👩‍✈️ Coqpit -[![CI](https://github.com/coqui-ai/coqpit/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/coqui-ai/coqpit/actions/workflows/main.yml) +[![CI](https://github.com/idiap/coqui-ai-coqpit/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/idiap/coqui-ai-coqpit/actions/workflows/main.yml) Simple, light-weight and no dependency config handling through python data classes with to/from JSON serialization/deserialization. -Currently it is being used by [🐸TTS](https://github.com/coqui-ai/TTS). +Currently it is being used by [🐸TTS](https://github.com/idiap/coqui-ai-TTS). + ## ❔ Why I need this What I need from a ML configuration library... @@ -293,7 +294,5 @@ if __name__ == '__main__': Install the pre-commit hook to automatically check your commits for style and hinting issues: ```bash -$ python .pre-commit-2.12.1.pyz install +uv run pre-commit install ``` - - diff --git a/VERSION b/VERSION deleted file mode 100644 index cd23180..0000000 --- a/VERSION +++ /dev/null @@ -1 +0,0 @@ -0.0.17 diff --git a/coqpit/__init__.py b/coqpit/__init__.py index 36fc452..05807b9 100644 --- a/coqpit/__init__.py +++ b/coqpit/__init__.py @@ -1 +1,5 @@ -from coqpit.coqpit import MISSING, Coqpit, check_argument, dataclass +import importlib.metadata + +from coqpit.coqpit import MISSING, Coqpit, check_argument, dataclass # noqa: F401 + +__version__ = importlib.metadata.version("coqpit") diff --git a/coqpit/coqpit.py b/coqpit/coqpit.py index e214c8b..a16705b 100644 --- a/coqpit/coqpit.py +++ b/coqpit/coqpit.py @@ -8,7 +8,7 @@ from dataclasses import Field, asdict, dataclass, fields, is_dataclass, replace from pathlib import Path from pprint import pprint -from typing import Any, Dict, Generic, List, Optional, Type, TypeVar, Union, get_type_hints +from typing import Any, Dict, Generic, List, Optional, Type, TypeVar, Union T = TypeVar("T") MISSING: Any = "???" @@ -132,24 +132,7 @@ def _is_optional_field(field) -> bool: bool: True if the input field is optional. """ # return isinstance(field.type, _GenericAlias) and type(None) in getattr(field.type, "__args__") - return type(None) in getattr(field.type, "__args__") - - -def my_get_type_hints( - cls, -): - """Custom `get_type_hints` dealing with https://github.com/python/typing/issues/737 - - Returns: - [dataclass]: dataclass to get the type hints of its fields. - """ - r_dict = {} - for base in cls.__class__.__bases__: - if base == object: - break - r_dict.update(my_get_type_hints(base)) - r_dict.update(get_type_hints(cls)) - return r_dict + return type(None) in field.type.__args__ def _serialize(x): @@ -342,7 +325,6 @@ def _validate_contracts(self): dataclass_fields = fields(self) for field in dataclass_fields: - value = getattr(self, field.name) if value is None: @@ -723,7 +705,7 @@ def load_json(self, file_name: str) -> None: Returns: Coqpit: new Coqpit with updated config fields. """ - with open(file_name, "r", encoding="utf8") as f: + with open(file_name, encoding="utf8") as f: input_str = f.read() dump_dict = json.loads(input_str) # TODO: this looks stupid 💆 diff --git a/pyproject.toml b/pyproject.toml index 9eb3284..935ab1a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -2,33 +2,54 @@ requires = ["setuptools"] build-backend = "setuptools.build_meta" -[flake8] -max-line-length=120 +[tool.setuptools.packages.find] +include = ["coqpit*"] -[tool.black] -line-length = 120 -target-version = ['py38'] -exclude = ''' +[project] +name = "coqpit" +version = "0.0.17" +description = "Simple (maybe too simple), light-weight config management through python data-classes." +readme = "README.md" +requires-python = ">=3.9" +license = {text = "MIT"} +authors = [ + {name = "Eren Gölge", email = "egolge@coqui.ai"} +] +maintainers = [ + {name = "Enno Hermann", email = "enno.hermann@gmail.com"} +] +classifiers = [ + "Programming Language :: Python", + "Programming Language :: Python :: 3", + "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", + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "Operating System :: POSIX :: Linux", + "Operating System :: MacOS", + "Operating System :: Microsoft :: Windows", +] +dependencies = [] + +[tool.uv] +dev-dependencies = [ + "coverage>=7", + "pre-commit>=3", + "pytest>=8", + "ruff==0.6.9", +] -( - /( - \.eggs # exclude a few common directories in the - | \.git # root of the project - | \.hg - | \.mypy_cache - | \.tox - | \.venv - | _build - | buck-out - | build - | dist - )/ - | foo.py # also separately exclude a file named foo.py in - # the root of the project -) -''' +[project.urls] +Repository = "https://github.com/idiap/coqui-ai-coqpit" +Issues = "https://github.com/idiap/coqui-ai-coqpit/issues" + +[tool.ruff] +target-version = "py39" +line-length = 120 +lint.extend-select = ["I", "B", "W", "A", "PLC", "PLE"] -[tool.isort] -line_length = 120 -profile = "black" -multi_line_output = 3 \ No newline at end of file +[tool.ruff.lint.pydocstyle] +convention = "google" diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index d5673ad..0000000 --- a/requirements.txt +++ /dev/null @@ -1 +0,0 @@ -dataclasses;python_version=='3.6' \ No newline at end of file diff --git a/requirements_dev.txt b/requirements_dev.txt deleted file mode 100644 index 3d5e87b..0000000 --- a/requirements_dev.txt +++ /dev/null @@ -1,4 +0,0 @@ -pylint -black -pytest -coverage diff --git a/setup.py b/setup.py index 83ae9a1..beda28e 100644 --- a/setup.py +++ b/setup.py @@ -1,71 +1,5 @@ #!/usr/bin/env python -import os +from setuptools import setup -import setuptools.command.build_py -import setuptools.command.develop -from setuptools import find_packages, setup - -cwd = os.path.dirname(os.path.abspath(__file__)) -with open(os.path.join(cwd, "VERSION")) as fin: - version = fin.read().strip() - - -class build_py(setuptools.command.build_py.build_py): # pylint: disable=too-many-ancestors - def run(self): - self.create_version_file() - setuptools.command.build_py.build_py.run(self) - - @staticmethod - def create_version_file(): - print("-- Building version " + version) - version_path = os.path.join(cwd, "version.py") - with open(version_path, "w") as f: - f.write("__version__ = '{}'\n".format(version)) - - -class develop(setuptools.command.develop.develop): - def run(self): - build_py.create_version_file() - setuptools.command.develop.develop.run(self) - - -requirements = open(os.path.join(cwd, "requirements.txt"), "r").readlines() -with open("README.md", "r", encoding="utf-8") as readme_file: - README = readme_file.read() - - -setup( - name="coqpit", - version=version, - url="https://github.com/erogol/coqpit", - author="Eren Gölge", - author_email="egolge@coqui.ai", - description="Simple (maybe too simple), light-weight config management through python data-classes.", - long_description=README, - long_description_content_type="text/markdown", - license="", - include_package_data=True, - packages=find_packages(include=["coqpit*"]), - project_urls={ - "Tracker": "https://github.com/coqui-ai/coqpit/issues", - "Repository": "https://github.com/coqui-ai/coqpit", - "Discussions": "https://github.com/coqui-ai/coqpit/discussions", - }, - cmdclass={ - "build_py": build_py, - "develop": develop, - }, - install_requires=requirements, - python_requires=">=3.7.0", - classifiers=[ - "Programming Language :: Python", - "Programming Language :: Python :: 3", - "Development Status :: 4 - Beta", - "Intended Audience :: Developers", - "Operating System :: POSIX :: Linux", - "Operating System :: MacOS", - "Operating System :: Microsoft :: Windows", - ], - zip_safe=False, -) +setup() diff --git a/tests/test_init_from_dict.py b/tests/test_init_from_dict.py index 8c26faf..b443523 100644 --- a/tests/test_init_from_dict.py +++ b/tests/test_init_from_dict.py @@ -32,9 +32,7 @@ class WithRequired(Coqpit): def test_new_from_dict(): ref_config = Reference(name="Fancy", size=3**10, people=[Person(name="Anonymous", age=42)]) - new_config = Reference.new_from_dict( - {"name": "Fancy", "size": 3**10, "people": [{"name": "Anonymous", "age": 42}]} - ) + new_config = Reference.new_from_dict({"name": "Fancy", "size": 3**10, "people": [{"name": "Anonymous", "age": 42}]}) # check values assert len(ref_config) == len(new_config) diff --git a/tests/test_nested_configs.py b/tests/test_nested_configs.py index 0016ed9..cb4afa3 100644 --- a/tests/test_nested_configs.py +++ b/tests/test_nested_configs.py @@ -27,7 +27,7 @@ class NestedConfig(Coqpit): val_e: int = None val_f: str = "Coqpit is great!" sc_list: List[SimpleConfig] = None - sc: SimpleConfig = SimpleConfig() + sc: SimpleConfig = field(default_factory=lambda: SimpleConfig()) union_var: Union[List[SimpleConfig], SimpleConfig] = field(default_factory=lambda: [SimpleConfig(), SimpleConfig()]) def check_values( diff --git a/tests/test_parse_argparse.py b/tests/test_parse_argparse.py index 8949df2..6c7b00e 100644 --- a/tests/test_parse_argparse.py +++ b/tests/test_parse_argparse.py @@ -114,8 +114,8 @@ class Config(Coqpit): try: config.parse_args(args) - assert False, "should not reach this" - except: # pylint: disable=bare-except + assert False, "should not reach this" # noqa: B011 + except: # noqa: E722 pass @@ -129,7 +129,7 @@ def test_argparse_with_required_field(): try: c = ArgparseWithRequiredField() # pylint: disable=no-value-for-parameter c.parse_args(args) - assert False + assert False # noqa: B011 except TypeError: # __init__ should fail due to missing val_a pass @@ -148,7 +148,7 @@ class SimpleConfig2(Coqpit): val_req: str # required field val_a: int = field(default=10, metadata={"help": "this is val_a of SimpleConfig2"}) val_b: int = field(default=None, metadata={"help": "this is val_b"}) - nested_config: SimplerConfig2 = SimplerConfig2() + nested_config: SimplerConfig2 = field(default_factory=lambda: SimplerConfig2()) mylist_with_default: List[SimplerConfig2] = field( default_factory=lambda: [SimplerConfig2(val_a=100), SimplerConfig2(val_a=999)], metadata={"help": "list of SimplerConfig2"}, diff --git a/tests/test_serialization.json b/tests/test_serialization.json index 8c110e4..e90dd3a 100644 --- a/tests/test_serialization.json +++ b/tests/test_serialization.json @@ -15,4 +15,4 @@ "age": 15 } ] -} \ No newline at end of file +} diff --git a/tests/test_simple_config.py b/tests/test_simple_config.py index 9485ca6..5b4dadf 100644 --- a/tests/test_simple_config.py +++ b/tests/test_simple_config.py @@ -39,7 +39,7 @@ def test_simple_config(): # try MISSING class argument try: - config.val_k + _ = config.val_k except AttributeError: print(" val_k needs a different value before accessing it.") config.val_k = 1000