Skip to main content

Mark objects imported with redundant aliases as public.

Project description

griffe-public-redundant-aliases

documentation gitpod gitter

Mark objects imported with redundant aliases as public.

Installation

This project is available to sponsors only, through my Insiders program. See Insiders explanation and installation instructions.

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

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.2.0.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for griffe_public_redundant_aliases-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1861e772e6eafe4cb0469f76522a2e9133a62a74bec4a3dd417e944b3c453cb2
MD5 d2d53ecde140743236ab8b2b876c908d
BLAKE2b-256 b2cc31f87cb5c5ba940527d6195f94f6c34e55e35d9cf222954b9a6153a4cd80

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for griffe_public_redundant_aliases-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f13a65dde27f8d7d70708781804eff2c75816b8c4e0922d2ecff72ee402dbde4
MD5 bbedd92e47f9374b6a75116d7cff1f28
BLAKE2b-256 3bb6906b1209bc77a05c3ff09e90833218d04b434b79ed710d7ceb925f15e5ee

See more details on using hashes here.

Supported by

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