Useful extra bits for Python

1.0.0 · abandoned · verified Sun Apr 12

The 'extras' library provides small, useful extensions to the Python standard library. It was originally developed to make code within the 'testtools' project cleaner, offering utilities like robust module import attempts and safe attribute checking. The last release was in May 2016, indicating it is no longer actively maintained.

Warnings

breaking The 'extras' library has not been updated since May 2016. It may not be compatible with modern Python versions (e.g., Python 3.8+) or contain practices that are now considered outdated or superseded by standard library features. Use with caution for new projects.
Fix: Thoroughly test compatibility with your target Python version. Consider reimplementing desired functionalities using modern Python features or more actively maintained libraries if 'extras' causes issues.
gotcha The name 'extras' can be confusing due to its overlap with the concept of 'extras' (optional dependencies) in Python packaging (e.g., `pip install package[extra_feature]`). This library 'extras' is a collection of utilities, distinct from packaging 'extras'. Also, there are other similarly named PyPI packages like 'python-extras' or 'streamlit-extras' which are different projects.
Fix: Ensure you are importing from the correct 'extras' package if you have multiple packages with similar names installed. Always refer to the specific GitHub repository or PyPI page to confirm the correct project.

Install

pip install extras Install stable version

Imports

try_import
```
from extras import try_import
```
Used for attempting to import modules or specific attributes from modules, returning None on failure rather than raising an ImportError.
try_imports
```
from extras import try_imports
```
Similar to try_import, but for multiple items from a module.
safe_hasattr
```
from extras import safe_hasattr
```
A utility to check for an attribute's existence on an object without risking an AttributeError if the attribute lookup itself is complex or has side effects.

Quickstart

This quickstart demonstrates the `try_import` function, a core utility from the 'extras' library. It attempts to import the 'requests' library and then uses it if successful, gracefully handling cases where 'requests' might not be installed. This pattern is useful for optional dependencies.

from extras import try_import

# Attempt to import a module, returning None if it fails
requests = try_import("requests")

if requests:
    print("The 'requests' library was imported successfully.")
    try:
        # Use an external service for a live example, if requests is available
        response = requests.get("https://api.github.com")
        print(f"GitHub API status: {response.status_code}")
    except Exception as e:
        print(f"Error accessing GitHub API: {e}")
else:
    print("The 'requests' library is not installed. Skipping API call.")

view raw JSON →