Skip to content

Added is_kebab_case utility in string class - #12206

Open
suryapratapsinghsuryavanshi wants to merge 3 commits into
TheAlgorithms:masterfrom
suryapratapsinghsuryavanshi:master
Open

suryapratapsinghsuryavanshi wants to merge 3 commits into
TheAlgorithms:masterfrom
suryapratapsinghsuryavanshi:master

Conversation

@suryapratapsinghsuryavanshi

Copy link
Copy Markdown
Contributor

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@algorithms-keeper algorithms-keeper Bot added the awaiting reviews This PR is ready to be reviewed label Oct 20, 2024

@priya-sundaram-dev priya-sundaram-dev left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution, @suryapratapsinghsuryavanshi. One correctness issue worth fixing before this can land:

re.match only anchors at the start of the string, so trailing junk slips through:

>>> is_kebab_case("variable-name!!!")
True   # should be False

Use re.fullmatch (or add a $ anchor) so the whole string must match. While you are at it, you can drop the separate "_" not in var_name guard and the \w hack by matching lowercase kebab directly, which also correctly rejects Variable-Name (kebab-case is conventionally lowercase):

return bool(re.fullmatch(r"[a-z0-9]+(?:-[a-z0-9]+)+", var_name))

Could you also add doctests for the trailing-character case and an uppercase input? Happy to re-review once updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting reviews This PR is ready to be reviewed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants