https://github.com/tripcher/flake8-forbidden-func

https://github.com/tripcher/flake8-forbidden-func

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tripcher/flake8-forbidden-func
• Owner: tripcher
• License: mit
• Created: 2022-03-29T04:14:01.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-11-09T15:50:38.000Z (almost 2 years ago)
• Last Synced: 2024-07-11T17:12:55.612Z (4 months ago)
• Language: Python
• Size: 31.3 KB
• Stars: 8
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-flake8-extensions - flake8-forbidden-func - Forbid some functions in some modules. (Limitations)

README

        
# flake8-forbidden-func

An extension for flake8 that forbids some functions in some modules.

## Installation

```terminal

pip install flake8-forbidden-func

```

## Example

```python

# users/views.py

from users import User

import datetime

def test_view():

    print(datetime.datetime.now())

    faz = User.objects.all().annotate().filter(a=2)

    baz = bar_func()

    if faz == baz:

        fuz = q.filter(a=1)

        return fuz.bar()

```

```

# setup.cfg

[flake8]

forbidden-functions =

    *.views: *.filter, views module should not use ORM filter

    *: datetime.datetime.now, we use django utils

allowed-functions =

    *.selectors: *.objects.*, only selectors module should use ORM

```

Usage:

```terminal

$ flake8 users/views.py

users/views.py:6:11: CFF001 datetime.datetime.now call is forbidden,since we use django utils.

users/views.py:7:11: CFF001 *.objects.* call is forbidden, since only selectors module should use ORM.

users/views.py:7:11: CFF001 *.objects.* call is forbidden, since only selectors module should use ORM.

users/views.py:7:11: CFF001 *.objects.* call is forbidden, since only selectors module should use ORM.

users/views.py:11:15: CFF001 *.filter call is forbidden, since views module should not use ORM filter.

```

Tested on Python 3.7+ and flake8 4.0+.

## Error codes

| Error code |                            Description                             |

|:----------:|:------------------------------------------------------------------:|

|   CFF001   |                  call is forbidden, since reason                   |

|   CFF000   | happens when we get unhandled exception during the linting process |