search
HomeBackend DevelopmentPython TutorialDeply: keep your python architecture clean

Deply: keep your python architecture clean

Large Python projects often evolve into complex codebases that are tough to maintain. Keeping track of imports, layers, and who depends on whom can quickly turn into a mess. Deply is here to help. It analyzes your code structure and enforces architectural rules, ensuring your Python project remains clean, modular, and easy to maintain—even as it grows.

Why Architectural Enforcement Matters

Python's flexibility makes it easy to introduce spaghetti code if we're not careful. Adding new modules, decorators, or even changing how classes inherit can introduce subtle dependency issues across large teams. Clear boundaries—enforced by automated checks—help keep code quality high. This approach boosts readability and team productivity.

What Is Deply?

Deply is a standalone tool that:

  1. Lets you define project layers (like views, models, services) in a YAML configuration.
  2. Collects code elements into these layers through rules (e.g., class_inherits, decorator_usage, file_regex).
  3. Enforces architectural policies to prevent undesired coupling or naming mishaps.

Why Not Use Another Tool?

  • pydeps: Focuses on visualizing imports.
  • import-linter: Checks import constraints.
  • pytestarch or pytest-archon: Relies on writing code-based tests for architecture.
  • Tach (Rust-based): Language-agnostic approach, may not align perfectly with Python specifics.

Deply's advantage is that it goes beyond imports, looking at decorators, class inheritance, file patterns, and more. Its YAML-based configuration makes it simpler to incorporate into CI pipelines without writing new test files.

New in 0.5.2

  1. Upgraded Collectors: More flexible ways to define classes and functions, including advanced regex patterns.
  2. Performance Boost: Deply now runs up to 10x faster than before. Integrating it with CI won't slow your builds.
  3. Expanded Rules: Additional checks for inheritance, decorator usage, and naming conventions let you design granular policies.

Installation

pip install deply

You'll get the latest version, currently 0.5.2.

Deply Configuration (deply.yaml)

Create a deply.yaml file in your project root. At a minimum, define the paths you want to analyze, any files to exclude, your layers, and rules. Below is a sample snippet for a Django-like project.

deply:
  paths:
    - /path/to/your/project

  exclude_files:
    - ".*\.venv/.*"

  layers:
    - name: models
      collectors:
        - type: bool
          any_of:
            - type: class_inherits
              base_class: "django.db.models.Model"
            - type: class_inherits
              base_class: "django.contrib.auth.models.AbstractUser"

    - name: views
      collectors:
        - type: file_regex
          regex: ".*/views_api.py"

  ruleset:
    views:
      disallow_layer_dependencies:
        - models
      enforce_function_decorator_usage:
        - type: bool
          any_of:
            - type: bool
              must:
                - type: function_decorator_name_regex
                  decorator_name_regex: "^HasPerm$"
                - type: function_decorator_name_regex
                  decorator_name_regex: "^extend_schema$"
            - type: function_decorator_name_regex
              decorator_name_regex: "^staticmethod$"

How it works:

  1. models layer collects classes inheriting from Django's Model or AbstractUser.
  2. views layer collects code from files ending with views_api.py.
  3. Rules:
  4. disallow_layer_dependencies: the views layer can't directly depend on models.
  5. enforce_function_decorator_usage: all functions in views need either (HasPerm and extend_schema) or staticmethod.

Running Deply

Once your config is ready, run:

pip install deply
  • --config=another_config.yaml lets you specify a different file.
  • --report-format=text|json|github-actions controls how violations are displayed.

Additional Examples

Class Naming:

deply:
  paths:
    - /path/to/your/project

  exclude_files:
    - ".*\.venv/.*"

  layers:
    - name: models
      collectors:
        - type: bool
          any_of:
            - type: class_inherits
              base_class: "django.db.models.Model"
            - type: class_inherits
              base_class: "django.contrib.auth.models.AbstractUser"

    - name: views
      collectors:
        - type: file_regex
          regex: ".*/views_api.py"

  ruleset:
    views:
      disallow_layer_dependencies:
        - models
      enforce_function_decorator_usage:
        - type: bool
          any_of:
            - type: bool
              must:
                - type: function_decorator_name_regex
                  decorator_name_regex: "^HasPerm$"
                - type: function_decorator_name_regex
                  decorator_name_regex: "^extend_schema$"
            - type: function_decorator_name_regex
              decorator_name_regex: "^staticmethod$"

All classes in the service layer must end with Service.

Function Naming:

deply analyze

All functions in tasks must start with task_.

Pro Tip: Combine multiple conditions with bool to form advanced logic (must, any_of, must_not), ensuring you can craft highly specific rules.

CI Integration

Add a step to your CI pipeline:

service:
  enforce_class_naming:
    - type: class_name_regex
      class_name_regex: ".*Service$"

Your pipeline can fail if any architectural violations are found.

Wrap-Up

Deply is designed to help you catch architectural violations before they become time-consuming refactors. By automating these checks, you can maintain a crisp, layered design, even on large teams.

  • GitHub: https://github.com/Vashkatsi/deply
  • PyPI: https://pypi.org/project/deply/

Feel free to test it out and adjust the configuration for your own needs. If you have questions or ideas, check out the repo for details on filing issues or contributing. Happy coding!

The above is the detailed content of Deply: keep your python architecture clean. For more information, please follow other related articles on the PHP Chinese website!

Statement
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
What is Python Switch Statement?What is Python Switch Statement?Apr 30, 2025 pm 02:08 PM

The article discusses Python's new "match" statement introduced in version 3.10, which serves as an equivalent to switch statements in other languages. It enhances code readability and offers performance benefits over traditional if-elif-el

What are Exception Groups in Python?What are Exception Groups in Python?Apr 30, 2025 pm 02:07 PM

Exception Groups in Python 3.11 allow handling multiple exceptions simultaneously, improving error management in concurrent scenarios and complex operations.

What are Function Annotations in Python?What are Function Annotations in Python?Apr 30, 2025 pm 02:06 PM

Function annotations in Python add metadata to functions for type checking, documentation, and IDE support. They enhance code readability, maintenance, and are crucial in API development, data science, and library creation.

What are unit tests in Python?What are unit tests in Python?Apr 30, 2025 pm 02:05 PM

The article discusses unit tests in Python, their benefits, and how to write them effectively. It highlights tools like unittest and pytest for testing.

What are Access Specifiers in Python?What are Access Specifiers in Python?Apr 30, 2025 pm 02:03 PM

Article discusses access specifiers in Python, which use naming conventions to indicate visibility of class members, rather than strict enforcement.

What is __init__() in Python and how does self play a role in it?What is __init__() in Python and how does self play a role in it?Apr 30, 2025 pm 02:02 PM

Article discusses Python's \_\_init\_\_() method and self's role in initializing object attributes. Other class methods and inheritance's impact on \_\_init\_\_() are also covered.

What is the difference between @classmethod, @staticmethod and instance methods in Python?What is the difference between @classmethod, @staticmethod and instance methods in Python?Apr 30, 2025 pm 02:01 PM

The article discusses the differences between @classmethod, @staticmethod, and instance methods in Python, detailing their properties, use cases, and benefits. It explains how to choose the right method type based on the required functionality and da

How do you append elements to a Python array?How do you append elements to a Python array?Apr 30, 2025 am 12:19 AM

InPython,youappendelementstoalistusingtheappend()method.1)Useappend()forsingleelements:my_list.append(4).2)Useextend()or =formultipleelements:my_list.extend(another_list)ormy_list =[4,5,6].3)Useinsert()forspecificpositions:my_list.insert(1,5).Beaware

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

Video Face Swap

Video Face Swap

Swap faces in any video effortlessly with our completely free AI face swap tool!

Hot Tools

Dreamweaver CS6

Dreamweaver CS6

Visual web development tools

EditPlus Chinese cracked version

EditPlus Chinese cracked version

Small size, syntax highlighting, does not support code prompt function

SAP NetWeaver Server Adapter for Eclipse

SAP NetWeaver Server Adapter for Eclipse

Integrate Eclipse with SAP NetWeaver application server.

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment