Скачать или смотреть Creating Custom Types in Python: Enhancing Type Annotations with NewType

Learn how to create custom types in Python using `NewType` to improve type annotations while maintaining clarity in your code. Discover practical examples and best practices!
---
This video is based on the question https://stackoverflow.com/q/75516144/ asked by the user 'Kim' ( https://stackoverflow.com/u/16383150/ ) and on the answer https://stackoverflow.com/a/75516422/ provided by the user 'Samwise' ( https://stackoverflow.com/u/3799759/ ) at 'Stack Overflow' website. Thanks to these great users and Stackexchange community for their contributions.

Visit these links for original content and any more details, such as alternate solutions, latest updates/developments on topic, comments, revision history etc. For example, the original title of the Question was: Annotation with custom types derived from numerical types in Python

Also, Content (except music) licensed under CC BY-SA https://meta.stackexchange.com/help/l...
The original Question post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license, and the original Answer post is licensed under the 'CC BY-SA 4.0' ( https://creativecommons.org/licenses/... ) license.

If anything seems off to you, please feel free to write me at vlogize [AT] gmail [DOT] com.
---
Creating Custom Types in Python: Enhancing Type Annotations with NewType

In the world of Python programming, type annotations are a powerful feature that helps developers write more readable and maintainable code. However, there are times when you may need to create custom types that derive from existing numerical types, such as float. This guide delves into how you can achieve this using NewType and highlights best practices for implementing it effectively in your projects.

The Challenge: Custom Types and Type Annotations

Imagine you have a situation where you want to provide clearer intentions behind the usage of different attributes in your class. You might define numerical attributes where you would like to differentiate between a standard float and a custom-defined type that carries specific meaning. The issue arises when these custom types are resolved back to their base types, losing the context you aim to provide.

The objective is to use custom types that not only enhance readability but also prevent type errors during runtime, allowing you to maintain clarity in the functions you define.

The Solution: Using NewType

The recommended approach for creating custom types is to leverage the NewType feature provided by Python's typing module. This allows you to create a distinct type that behaves like the base type but maintains its uniqueness in type-checking scenarios. Here’s how to implement it:

Step-by-Step Implementation

Import Required Modules: Start by importing the NewType from the typing module.

[[See Video to Reveal this Text or Code Snippet]]

Create a Custom Type: Use NewType to create a new identifier that behaves like float but is treated as a separate type by static type checkers.

[[See Video to Reveal this Text or Code Snippet]]

Define a Class with Custom Attributes: When defining a class, ensure attributes initialized with the custom type must explicitly convert their values to this new type.

[[See Video to Reveal this Text or Code Snippet]]

Working with Custom Types in Functions

When using these custom types in function definitions, the type checker will enforce that only values of the appropriate type can be passed.

[[See Video to Reveal this Text or Code Snippet]]

Example Usage

[[See Video to Reveal this Text or Code Snippet]]

Addressing Common Concerns

Why Doesn’t Mypy Automatically Convert Types? While it might seem intuitive to treat a value of type float as its custom type, tools like mypy do not automatically convert between less specific and more specific types. This strictness helps prevent bugs that could occur from unintended type coercion.

Intentional Clarity: By explicitly defining types, you're not only guiding the type checker but also making your code self-documenting. Anyone reading your code will quickly understand the intended use of each attribute.

Conclusion

In summary, using NewType in Python to create custom numerical types can significantly enhance the clarity and maintainability of your code. By defining custom types and implementing them carefully in class attributes and functions, you can improve type safety and fully leverage the capabilities of static type checkers like mypy. Remember, you can't rely on automatic type conversion; clear type definitions promote a better coding practice and reduce the likelihood of errors.

Embrace the power of custom types and enhance your Python programming journey today!