setup.cfg

# -*- coding: utf-8 -*-
#
#    mslib.setup
#    ~~~~~~~~~~~
#
#    setup.cfg
#
#    This file is part of mss.
#
#    :copyright: Copyright 2016-2017 Reimar Bauer, Joern Ungermann
#    :copyright: Copyright 2016-2026 by the MSS team, see AUTHORS.
#    :license: APACHE-2.0, see LICENSE for details.
#
#    Licensed under the Apache License, Version 2.0 (the "License");
#    you may not use this file except in com#pliance 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.

[aliases]
test = pytest

[coverage:run]
branch = True
relative_files = True
source = mslib
omit =
 mslib/msui/qt5/*py
 tests/*

[tool:pytest]
norecursedirs = .git .idea .cache

[flake8]
ignore = E124,E125,E402,W503,W504,A005
max-line-length = 120
exclude = mslib/msui/qt5/*.py, mslib/mscolab/migrations/*.py

# Architectural import contracts (checked by `pixi run -e dev lint-imports` and CI).
# The target dependency direction is documented in ARCHITECTURE.md. Every entry in
# an ignore_imports list below is a grandfathered, known violation of the target
# architecture -- shrink these lists, never grow them.
[importlinter]
root_package = mslib
include_external_packages = True

[importlinter:contract:gui-isolation]
name = Only the GUI package may import mslib.msui
type = forbidden
source_modules =
    mslib.mscolab
    mslib.mswms
    mslib.utils
    mslib.plugins
    mslib.msidp
    mslib.support
forbidden_modules =
    mslib.msui
ignore_imports =
    mslib.plugins.io.csv -> mslib.msui.flighttrack
    mslib.plugins.io.text -> mslib.msui.flighttrack
    mslib.plugins.io.flitestar -> mslib.msui.flighttrack

[importlinter:contract:server-isolation]
name = Only the shared protocol constants of mslib.mscolab may be imported elsewhere
type = forbidden
source_modules =
    mslib.msui
    mslib.mswms
    mslib.utils
    mslib.plugins
    mslib.msidp
    mslib.support
    mslib.autoplot
forbidden_modules =
    mslib.mscolab
ignore_imports =
    # mslib.mscolab.api is the typed client/server contract (schemas +
    # endpoint registry) plus the shared socket/message vocabulary
    # (events.py, message_type.py): the one part of mslib.mscolab any msui
    # module may import. Reworked from a per-call-site whitelist (2 lines for
    # mslib.msui.mscolab only) into this wildcard once a 3rd file
    # (mscolab_connect_dialog.py) needed it too. The api-leaf contract below
    # keeps this safe.
    mslib.msui.* -> mslib.mscolab.api.*

[importlinter:contract:api-leaf]
name = mslib.mscolab.api (the mss-mscolab-api package) needs nothing but the standard library
type = forbidden
source_modules =
    mslib.mscolab.api
# the rest of mslib.mscolab is listed module by module: a new module of mslib.mscolab
# has to be added here
forbidden_modules =
    mslib.mscolab.app
    mslib.mscolab.auth
    mslib.mscolab.blueprints
    mslib.mscolab.chat_manager
    mslib.mscolab.cli_notify
    mslib.mscolab.conf
    mslib.mscolab.custom_migration_types
    mslib.mscolab.file_manager
    mslib.mscolab.forms
    mslib.mscolab.mail
    mslib.mscolab.migrations
    mslib.mscolab.models
    mslib.mscolab.mscolab
    mslib.mscolab.seed
    mslib.mscolab.server
    mslib.mscolab.sockets_manager
    mslib.mscolab.utils
    mslib.msui
    mslib.mswms
    mslib.utils
    mslib.support
    mslib.plugins
    mslib.autoplot
    mslib.msidp
    PyQt5
    numpy
    flask
    flask_cors
    flask_httpauth
    flask_mail
    flask_migrate
    flask_socketio
    flask_sqlalchemy
    flask_wtf
    alembic
    sqlalchemy
    werkzeug
    saml2

[importlinter:contract:wms-isolation]
name = No other mslib package may import the mswms server
type = forbidden
source_modules =
    mslib.msui
    mslib.mscolab
    mslib.utils
    mslib.plugins
    mslib.msidp
    mslib.support
    mslib.autoplot
forbidden_modules =
    mslib.mswms

[importlinter:contract:utils-base-layer]
name = mslib.utils is the base layer: no other mslib package, no Qt, no keyring, no server stack
type = forbidden
source_modules =
    mslib.utils
forbidden_modules =
    mslib.support
    mslib.autoplot
    mslib.plugins
    mslib.msidp
    PyQt5
    keyring
    flask
    flask_cors
    flask_httpauth
    flask_mail
    flask_migrate
    flask_socketio
    flask_sqlalchemy
    flask_wtf
    alembic
    sqlalchemy
    werkzeug
    saml2

[importlinter:contract:msidp-standalone]
name = mslib.msidp is standalone: no other mslib package, no Qt, numpy or flask
type = forbidden
source_modules =
    mslib.msidp
forbidden_modules =
    mslib.utils
    mslib.msui
    mslib.mswms
    mslib.mscolab
    mslib.plugins
    mslib.support
    mslib.autoplot
    PyQt5
    numpy
    flask

[importlinter:contract:msidp-not-imported]
name = No other mslib package imports mslib.msidp (mss-msidp is a package of its own)
type = forbidden
source_modules =
    mslib.utils
    mslib.msui
    mslib.mswms
    mslib.mscolab
    mslib.plugins
    mslib.support
    mslib.autoplot
forbidden_modules =
    mslib.msidp

[importlinter:contract:servers-without-qt]
name = The servers mswms and mscolab never import Qt
type = forbidden
source_modules =
    mslib.mswms
    mslib.mscolab
forbidden_modules =
    PyQt5

[importlinter:contract:client-without-server-stack]
name = The client (msui, plugins, support, autoplot) never imports the server stack
type = forbidden
source_modules =
    mslib.msui
    mslib.plugins
    mslib.support
    mslib.autoplot
forbidden_modules =
    flask
    flask_cors
    flask_httpauth
    flask_mail
    flask_migrate
    flask_socketio
    flask_sqlalchemy
    flask_wtf
    alembic
    sqlalchemy
    werkzeug
    saml2