Python Public vs Private Modules and Attributes

Public vs Private Modules and Attributes is part of Software architecture and release engineering. This lesson focuses on the exact problem it solves, the behavior you can observe, and the limits to understand before applying it in your own project.

An underscore signals a non-public implementation detail by convention; __all__ defines names imported by a wildcard import, not access control.

What You Will Learn

• Identify the purpose of Public vs Private Modules and Attributes and when it is useful.
• Understand the worked example and what happens to each input.
• Recognize the relevant compatibility, safety or correctness limitation.
• Apply the technique to a small exercise and verify the result.

Before You Start

You can run the Python-only portion in a local interpreter. Before adapting the example for real files, the operating system or production data, make a disposable test environment and record the Python version.

How It Works

An underscore signals a non-public implementation detail by convention; __all__ defines names imported by a wildcard import, not access control.

Focus on the public contract first: what goes in, what comes out, what may fail, and which state changes. Internal implementation details are useful only when they explain a measured behavior or guide a safe design decision.

Step-by-Step Example

The following self-contained example is intentionally small enough to read line by line. Comments containing another programming language or a terminal command are illustrative and must not be executed as Python source.

# package/__init__.py example: define a narrow public surface
__all__ = ['calculate_total']

def calculate_total(values):
    return sum(values)

def _normalize(value):
    return float(value)

print(calculate_total([2, 3]))

Understanding the Example

1. The example prepares its own values or collaborators before calling the main operation. Change only one input at a time to see the effect.
2. A named function isolates one behavior so the example can call it again and check its output independently.
3. The print call exposes the result or a specific property of the operation. Compare it with your prediction rather than memorizing the line.
4. The important rule is: An underscore signals a non-public implementation detail by convention; __all__ defines names imported by a wildcard import, not access control.

Expected behavior: An underscore signals a non-public implementation detail by convention; __all__ defines names imported by a wildcard import, not access control. Exact timing values, platform paths, interpreter internals and native library availability may differ between machines.

Practical Use and Design Choices

Start with an observable requirement and a test. Separate the domain rule from input parsing, output formatting and infrastructure so failures can be reproduced with small examples.

Prefer the simplest design that meets the requirement. New layers, caching, concurrency or plugin systems should be motivated by actual use cases and measurable constraints.

A Second Scenario to Consider

Imagine using the same technique with an unavailable feature, an unexpected input or a larger workload. Before editing the code, identify which assumption of the first example no longer holds. Decide whether to reject the input, choose a safe fallback or change the design.

For this specific lesson: Move implementation functions to a private helper module.

Important Limitations

Document which public names are supported and avoid breaking them casually.

Practice Exercise

1. Move implementation functions to a private helper module.
2. Write down the expected result before running a changed case.
3. Add a test for one normal case and one invalid or boundary case. Record the observed result and explain any difference.

Common Beginner Mistakes

• Document which public names are supported and avoid breaking them casually.
• Document which public names are supported and avoid breaking them casually.
• Applying Public vs Private Modules and Attributes without checking input types, resource ownership, side effects or version support.

Key Takeaways

• An underscore signals a non-public implementation detail by convention; __all__ defines names imported by a wildcard import, not access control.
• The worked example demonstrates the central behavior of Public vs Private Modules and Attributes using visible results and bounded input.
• A useful next step is: Move implementation functions to a private helper module.