tlsfuzzer/tlslite-ng

Pythonic variable/method naming

Open

#200 opened on Dec 13, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (95 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (269 stars)
PR merge metrics
 (PR metrics pending)

Description

Currently a lot of methods are using names that are not pythonic (they use camelCase)

provide accessor methods with old names, rename existing ones to be pythonic, cause the old methods to raise DeprecationWarning on use.

(note that for unit tests, warnings.catch_warnings() can be used to hide testing of those accessors)

Contributor guide

Research direction
Scan the codebase for methods using camelCase, create a list, and rename them to snake case while adding deprecated accessors. Use warnings.warn with DeprecationWarning. Run tests to ensure no breakage.
Tech stack
python
Domain
backend
Issue type
Refactor
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.
1-3 hours
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
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80