Skip to main content

Import order detection

Project description

A script to detect that the import order matches Mozilla WebDev Python guidelines. Usage:

baked.py [filename] [filename..]

Filename can be a glob. Or multiple filenames. For example:

baked.py apps/*.py mkt/*.py

Baked will also accept files being piped to it, for example:

git diff-index HEAD^ --name-only | baked

Baked loads a confg file as JSON. It will look in the following places for the file:

  • the current directory for .baked

  • the users profile directory for .baked

For an example see:

https://gist.github.com/andymckay/5507339

The config file contains:

  • order: the list of orders of import blocks. This allows you to group your imports into categories.

  • fallback: if a category is not found for lib, what should it fall back to, for most this will be local.

  • from_order: a dictionary of sections with a boolean value for each section. If the value is false, then baked will not care that an import came before from. Default is true for each category.

  • modules: a dictionary of categories and a list of modules. This allows baked to put each module in the category.

If you’d like to exclude an import from baked add the comment #NOQA.

Guidelines:

http://mozweb.readthedocs.org/en/latest/coding.html#import-statements

With one exception, we ignore that imports should be ordered CONSTANT, Class, var. Just sort by alpha, case insensitive. That’s easier for everyone to parse.

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

baked-0.1.4.tar.gz (4.7 kB view details)

Uploaded Source

File details

Details for the file baked-0.1.4.tar.gz.

File metadata

  • Download URL: baked-0.1.4.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for baked-0.1.4.tar.gz
Algorithm Hash digest
SHA256 a44808c3c7d0bec82f05f5b727a62d64b6fc0569b6f1170fcb718b89f2c26e05
MD5 145fb044fa71dcc2fa743f786584d45b
BLAKE2b-256 e8102123174016dc70ad32de48e92ab705dfa72608d5745158c7e55f6478d9df

See more details on using hashes here.

Supported by

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