setup.cfg

# Copyright (c) 2021-2023, NVIDIA CORPORATION.
# 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.

# See the docstring in versioneer.py for instructions. Note that you must
# re-run 'versioneer.py setup' after changing this section, and commit the
# resulting files.

# ===== versioneer Config =====
[versioneer]
VCS = git
style = pep440
versionfile_source = morpheus/_version.py
versionfile_build = morpheus/_version.py
tag_prefix = v
parentdir_prefix = morpheus-

# ===== isort Config =====
[isort]
line_length=120
multi_line_output=3
include_trailing_comma=True
force_grid_wrap=0
combine_as_imports=True
order_by_type=True
force_single_line=True
src_paths=morpheus,tests
known_dask=
    dask
    distributed
    dask_cuda
known_rapids=
    nvstrings
    nvcategory
    nvtext
    cudf
    cuml
    cugraph
    dask_cudf
known_first_party=
    morpheus
default_section=THIRDPARTY
sections=FUTURE,STDLIB,THIRDPARTY,DASK,RAPIDS,FIRSTPARTY,LOCALFOLDER
skip=
    __init__.py
    .eggs
    .git
    .hg
    .mypy_cache
    .tmp
    .tox
    .venv
    buck-out
    build
    dist
    models
    morpheus/_version.py
    thirdparty
    # Skip versioneer.py as its third-party
    versioneer.py

# ===== flake8 Config =====
[flake8]
filename = *.py, *.pyx, *.pxd

# TODO: Remove dfencoder https://github.com/nv-morpheus/Morpheus/issues/786
exclude =
   __pycache__,
   .git,
   .tmp/,
   *.egg,
   build/,
   cpp,
   docs,
   models/,
   morpheus/models/dfencoder/*.py,
   thirdparty,
   versioneer.py
max-line-length = 120
max-doc-length = 120

extend-ignore =
    # Ignore missing docstrings __init__ methods as we document those on the class
    D107,
    # Don't require quotes to be placed on the same line as a one-line docstring, useful when the docstring is close
    # to the line limit
    D200,
    # Allow a blank line between a docstring and the code
    D202,
    # D204: 1 blank line required after class docstring
    D204,
    # D205: 1 blank line required between summary line and description (allow for a paragraph)
    D205,
    # D400: First line should end with a period (only works if we're adhering to D205)
    D400,
    # D401: First line should be in imperative mood
    D401

# Cython Rules ignored:
# E999: invalid syntax (works for Python, not Cython)
# E225: Missing whitespace around operators (breaks cython casting syntax like <int>)
# E226: Missing whitespace around arithmetic operators (breaks cython pointer syntax like int*)
# E227: Missing whitespace around bitwise or shift operator (Can also break casting syntax)
# W503: line break before binary operator (breaks lines that start with a pointer)
# W504: line break after binary operator (breaks lines that end with a pointer)

per-file-ignores =
    # imported but unused
    __init__.py: F401, E402
    # Ignore additional deps needed for examples
    examples/*.py: F821
    # Cython Exclusions
    *.pyx: E999, E225, E226, E227, W503, W504
    *.pxd: E999, E225, E226, E227, W503, W504
    # Remove some documentation requirements for tests
    tests/*.py:
        # D100: Missing docstring in public module
        D100,
        # D101: Missing docstring in public class
        D101,
        # D102: Missing docstring in public method
        D102,
        # D103: Missing docstring in public function
        D103
        
[yapf]
based_on_style = pep8
column_limit = 120
split_all_top_level_comma_separated_values = true
join_multiple_lines = true
indent_dictionary_value = true