8000 PEP440 normalization code structure suggestions by aignas · Pull Request #1 · vonschultz/rules_python · GitHub
[go: up one dir, main page]
Skip to content

PEP440 normalization code structure suggestions 8000 #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 19 commits into from
Aug 28, 2023
Merged

PEP440 normalization code structure suggestions #1

Changes from 1 commit
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0705d10
refactor: move normalization into a separate file
aignas Aug 27, 2023
d014bc6
refactor: move helper nested defs to be private defs
aignas Aug 27, 2023
1c79b26
refactor: move version and contexts to a self struct
aignas Aug 27, 2023
a9d06f0
refactor: create a normalize function
aignas Aug 27, 2023
df2f124
refactor: move open_context to be a method on the normalizer struct
aignas Aug 27, 2023
1355341
refactor: move more predicates outside
aignas Aug 27, 2023
0a93c81
refactor: move close_context to self.close_context
aignas Aug 27, 2023
9ed69be
refactor: move accept to self.accept
aignas Aug 27, 2023
7f80890
refactor: move all of the methods to be functions instead
aignas Aug 27, 2023
f4be867
refactor: restrict usage of contexts to the internal parser functions
aignas Aug 27, 2023
efc66d4
refactor: move accept back to be a regular function
aignas Aug 27, 2023
d2f6b74
refactor: rename context -> ctx
aignas Aug 27, 2023
03f6348
refactor: rename tail -> context
aignas Aug 27, 2023
dca427c
refactor: drop parameters from open_context
aignas Aug 27, 2023
fcfff02
refactor: rename pop -> pop_context
aignas Aug 27, 2023
ac27a62
refactor: rename version -> input in the parser
aignas Aug 27, 2023
872a648
refactor: rename pop_context -> discard
aignas Aug 27, 2023
4237439
refactor: rename close_context -> accept
aignas Aug 27, 2023
1076fd7
refactor: use parser.discard and parser.accept methods
aignas Aug 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: move open_context to be a method on the normalizer struct
  • Loading branch information
@aignas
aignas committed Aug 27, 2023
commit df2f124a17b30ab443765221b885c1415f73c01a
89 changes: 55 additions & 34 deletions python/private/py_wheel_normalize_pep440.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@

"Implementation of PEP440 version string normalization"

def mkmethod(self, method):
"""Bind a struct as the first arg to a function.

This is loosely equivalent to creating a bound method of a class.
"""
return lambda *args, **kwargs: method(self, *args, **kwargs)

def _isdigit(token):
return token.isdigit()

Expand All @@ -24,6 +31,37 @@ def _lower(token):
# PEP 440: Case sensitivity
return token.lower()

def _open_context(self, start):
"""Open an new parsing context.

If the current parsing step succeeds, call close_context().
If the current parsing step fails, call contexts.pop() to
go back to how it was before we opened a new context.

Args:
self: The normalizer.
start: index into `version` indicating where the current
parsing step starts.
"""
self.contexts.append({"norm": "", "start": start})
return self.contexts[-1]

def _new(version):
"""Create a new normalizer"""
self = struct(
version = version.strip(), # PEP 440: Leading and Trailing Whitespace
contexts = [],
)
public = struct(
# methods: keep sorted
open_context = mkmethod(self, _open_context),

# attributes: keep sorted
contexts = self.contexts,
version = self.version,
)
return public

def normalize_pep440(version):
"""Escape the version component of a filename.

Expand All @@ -37,24 +75,7 @@ def normalize_pep440(version):
string containing the normalized version.
"""

self = struct(
version = version.strip(), # PEP 440: Leading and Trailing Whitespace
contexts = [],
)

def open_context(start):
"""Open an new parsing context.

If the current parsing step succeeds, call close_context().
If the current parsing step fails, call contexts.pop() to
go back to how it was before we opened a new context.

Args:
start: index into `version` indicating where the current
parsing step starts.
"""
self.contexts.append({"norm": "", "start": start})
return self.contexts[-1]
self = _new(version)

def close_context():
"""Close the current context successfully and merge the results."""
Expand Down Expand Up @@ -122,7 +143,7 @@ def normalize_pep440(version):
actually be valid.

"" 8000 "
context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])

if not accept(is_("{"), str):
self.contexts.pop()
Expand All @@ -143,7 +164,7 @@ def normalize_pep440(version):
def accept_digits():
"""Accept multiple digits (or placeholders)."""

context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])
start = context["start"]

for i in range(start, len(self.version) + 1):
Expand All @@ -161,7 +182,7 @@ def normalize_pep440(version):

def accept_string(string, replacement):
"""Accept a `string` in the input. Output `replacement`."""
context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])

for character in string.elems():
if not accept(in_([character, character.upper()]), ""):
Expand All @@ -176,7 +197,7 @@ def normalize_pep440(version):
def accept_alnum():
"""Accept an alphanumeric sequence."""

context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])
start = context["start"]

for i in range(start, len(self.version) + 1):
Expand All @@ -191,7 +212,7 @@ def normalize_pep440(version):

def accept_dot_number():
"""Accept a dot followed by digits."""
open_context(self.contexts[-1]["start"])
self.open_context(self.contexts[-1]["start"])

if accept(is_("."), ".") and accept_digits():
close_context()
Expand All @@ -213,7 +234,7 @@ def normalize_pep440(version):

def accept_separator_alnum():
"""Accept a separator followed by an alphanumeric string."""
open_context(self.contexts[-1]["start"])
self.open_context(self.contexts[-1]["start"])

# PEP 440: Local version segments
if (
Expand All @@ -240,7 +261,7 @@ def normalize_pep440(version):

def accept_epoch():
"""PEP 440: Version epochs."""
context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])
if accept_digits() and accept(is_("!"), "!"):
if context["norm"] == "0!":
self.contexts.pop()
Expand All @@ -254,7 +275,7 @@ def normalize_pep440(version):

def accept_release():
"""Accept the release segment, numbers separated by dots."""
open_context(self.contexts[-1]["start"])
self.open_context(self.contexts[-1]["start"])

if not accept_digits():
self.contexts.pop()
Expand All @@ -266,7 +287,7 @@ def normalize_pep440(version):

def accept_pre_l():
"""PEP 440: Pre-release spelling."""
open_context(self.contexts[-1]["start"])
self.open_context(self.contexts[-1]["start"])

if (
accept_string("alpha", "a") or
Expand All @@ -286,7 +307,7 @@ def normalize_pep440(version):

def accept_prerelease():
"""PEP 440: Pre-releases."""
context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])

# PEP 440: Pre-release separators
accept(in_(["-", "_", "."]), "")
Expand All @@ -306,7 +327,7 @@ def normalize_pep440(version):

def accept_implicit_postrelease():
"""PEP 440: Implicit post releases."""
context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])

if accept(is_("-"), "") and accept_digits():
context["norm"] = ".post" + context["norm"]
Expand All @@ -318,7 +339,7 @@ def normalize_pep440(version):

def accept_explicit_postrelease():
"""PEP 440: Post-releases."""
context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])

# PEP 440: Post release separators
if not accept(in_(["-", "_", "."]), "."):
Expand All @@ -344,7 +365,7 @@ def normalize_pep440(version):

def accept_postrelease():
"""PEP 440: Post-releases."""
open_context(self.contexts[-1]["start"])
self.open_context(self.contexts[-1]["start"])

if accept_implicit_postrelease() or accept_explicit_postrelease():
close_context()
Expand All @@ -355,7 +376,7 @@ def normalize_pep440(version):

def accept_devrelease():
"""PEP 440: Developmental releases."""
context = open_context(self.contexts[-1]["start"])
context = self.open_context(self.contexts[-1]["start"])

# PEP 440: Development release separators
if not accept(in_(["-", "_", "."]), "."):
Expand All @@ -376,7 +397,7 @@ def normalize_pep440(version):

def accept_local():
"""PEP 440: Local version identifiers."""
open_context(self.contexts[-1]["start"])
self.open_context(self.contexts[-1]["start"])

if accept(is_("+"), "+") and accept_alnum():
accept_separator_alnum_sequence()
Expand All @@ -387,7 +408,7 @@ def normalize_pep440(version):
return False

def normalize(self):
open_context(0)
self.open_context(0)
accept(is_("v"), "") # PEP 440: Preceding v character
accept_epoch()
accept_release()
Expand Down
0