Skip to main content

Arbitrary regex checker, extension for flake8

Project description

# flake8-regex
Searches for regex patterns provided in a configuration file

## Usage

These steps are tested using Mac OSX 10.10.5 and python 3.4.2

1- Get flake8 and flake8-regex:

pip install flake8 flake8-regex

2- Create a config module such as


import re

rules = [
'regex': re.compile(r"""(^simple.*|
^pattern.*)""", re.X),
'code': '100', # Any 3 digit code, 'R' namespace will be prefixed to that in the report
'message': "neither 'simple' nor 'pattern' are allowed at the beginning of a line",

**Important note**: The config file can be named anything, but the list MUST be named `rules`

3- Set a FLAKE8_REGEX_CONFIG_MODULE environment variable


4- run it!

For example:

**for file**:

simple = "foo"
pattern = "bar"
good = None

flake8 R100 neither 'simple' nor 'pattern' are allowed at the beginning of a line R100 neither 'simple' nor 'pattern' are allowed at the beginning of a line

## Known issues

The current implementation only reports the first item in the list of rules that matches the line
evaluated. In the future all matching items will be reported.

Project details

Release history Release notifications | RSS feed

This version


Download files

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

Source Distribution

flake8-regex-0.3.tar.gz (2.7 kB view hashes)

Uploaded source

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