Skip to main content

Mark objects imported with redundant aliases as public.

Project description

griffe-public-redundant-aliases

ci documentation pypi version gitter

Mark objects imported with redundant aliases as public.

Installation

pip install griffe-public-redundant-aliases

Usage

Enable the griffe_public_redundant_aliases extension. Now all objects imported with redundant aliases will be marked as public, as per the convention.

# Following objects will be marked as public.
from somewhere import Thing as Thing
from somewhere import Other as Other

# Following object won't be marked as public.
from somewhere import Stuff

With MkDocs:

plugins:
- mkdocstrings:
    handlers:
      python:
        options:
          extensions:
          - griffe_public_redundant_aliases

Sponsors

Silver sponsors

FastAPI

Bronze sponsors

Nixtla


ofek samuelcolvin tlambert03 ssbarnea femtomc cmarqu kolenaIO ramnes machow BenHammersley trevorWieland MarcoGorelli analog-cbarber OdinManiac rstudio-sponsorship schlich butterlyn livingbio NemetschekAllplan EricJayHartman 15r10nk activeloopai roboflow cmclaughlin blaisep RapidataAI rodolphebarbanneau theSymbolSyndicate blakeNaccarato ChargeStorm Alphadelta14 Cusp-AI

And 7 more private sponsor(s).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

griffe_public_redundant_aliases-0.3.1.tar.gz (27.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file griffe_public_redundant_aliases-0.3.1.tar.gz.

File metadata

File hashes

Hashes for griffe_public_redundant_aliases-0.3.1.tar.gz
Algorithm Hash digest
SHA256 8feff8b746b142f4020c2031d423faf3a1af8734c34c01b1261ea9846eb0ba42
MD5 534b088df29d39f9b07cc5f1e1de9b7c
BLAKE2b-256 fca2fed1980f87d4b26668aa6dd29dcb58e6b86d0e946a224356f28be6f5a9d6

See more details on using hashes here.

File details

Details for the file griffe_public_redundant_aliases-0.3.1-py3-none-any.whl.

File metadata

File hashes

Hashes for griffe_public_redundant_aliases-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fecf95a1d2870ce67b50460cd88e1b13c2c8dad8a47e43d7407b6b5d5b0a4f13
MD5 69e35c258a034ccbf5c52d8cee891f00
BLAKE2b-256 081eec805eee2fc6bf834f06f7f22a2b89728e890144c691d52c5af5d30f7616

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page