PyCQA/flake8-bugbear

Proposed opinionated warning against re.match

Open

#132 opened on Aug 13, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (116 forks)github user discovery
help wantedquestion

Repository metrics

Stars
 (1,116 stars)
PR merge metrics
 (Avg merge 4h 17m) (3 merged PRs in 30d)

Description

Technically, using re.match is valid. Realistically, the author probably meant .search and is going to lose a ton of time trying to figure out why her regex isn't working.

I'm speaking purely in compassion toward more junior developers; I would obviously never make such an elementary mistake myself. https://twitter.com/catherinedevlin/status/1257507010041520139

If you think you're likely to accept it, I'd be interested in authoring such a warning.

Contributor guide

Research direction
Examine the existing warning implementations in flake8 bugbear to understand the pattern, then create a new warning that flags usage of re.match where it might be intended as re.search. Consider cases like checking if the regex pattern is being used for matching at the beginning of a string.
Tech stack
python
Domain
devtools
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70