adafruit-mirror/circup
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

make check now matches CI, re-ran on all files

Browse source
This commit is contained in:
askpatricw 2020-12-30 18:30:26 -08:00
parent 076fe8e8c2
commit 776e32e2a3
5 changed files with 40 additions and 89 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
Makefile
View file

@ -44,8 +44,7 @@ coverage: clean
tidy: clean
@echo "\nTidying code with black..."
black -l 79 circup.py
black -l 79 tests
black --target-version=py35 .
check: clean tidy pycodestyle pyflakes coverage

66
circup.py
View file

@ -146,9 +146,7 @@ class Module:
try:
return compare(self.device_version, self.bundle_version) < 0
except ValueError as ex:
logger.warning(
"Module '%s' has incorrect semver value.", self.name
)
logger.warning("Module '%s' has incorrect semver value.", self.name)
logger.warning(ex)
return True # Assume out of date to try to update.
@ -256,10 +254,7 @@ def find_device():
try:
for disk in "ABCDEFGHIJKLMNOPQRSTUVWXYZ":
path = "{}:\\".format(disk)
if (
os.path.exists(path)
and get_volume_name(path) == "CIRCUITPY"
):
if os.path.exists(path) and get_volume_name(path) == "CIRCUITPY":
device_dir = path
# Report only the FIRST device found.
break
@ -316,9 +311,7 @@ def extract_metadata(path):
if DUNDER_ASSIGN_RE.search(line):
exec(line, result)
if "__builtins__" in result:
del result[
"__builtins__"
] # Side effect of using exec, not needed.
del result["__builtins__"] # Side effect of using exec, not needed.
if result:
logger.info("Extracted metadata: %s", result)
return result
@ -371,9 +364,7 @@ def find_modules():
device_version = device_metadata.get("__version__")
bundle_version = bundle_metadata.get("__version__")
mpy = device_metadata["mpy"]
result.append(
Module(path, repo, device_version, bundle_version, mpy)
)
result.append(Module(path, repo, device_version, bundle_version, mpy))
return result
except Exception as ex:
# If it's not possible to get the device and bundle metadata, bail out
@ -448,23 +439,17 @@ def get_modules(path):
if not os.path.basename(os.path.normpath(d)).startswith(".")
]
single_file_mods = single_file_py_mods + single_file_mpy_mods
for sfm in [
f for f in single_file_mods if not os.path.basename(f).startswith(".")
]:
for sfm in [f for f in single_file_mods if not os.path.basename(f).startswith(".")]:
metadata = extract_metadata(sfm)
metadata["path"] = sfm
result[
os.path.basename(sfm).replace(".py", "").replace(".mpy", "")
] = metadata
result[os.path.basename(sfm).replace(".py", "").replace(".mpy", "")] = metadata
for dm in directory_mods:
name = os.path.basename(os.path.dirname(dm))
metadata = {}
py_files = glob.glob(os.path.join(dm, "*.py"))
mpy_files = glob.glob(os.path.join(dm, "*.mpy"))
all_files = py_files + mpy_files
for source in [
f for f in all_files if not os.path.basename(f).startswith(".")
]:
for source in [f for f in all_files if not os.path.basename(f).startswith(".")]:
metadata = extract_metadata(source)
if "__version__" in metadata:
metadata["path"] = dm
@ -531,16 +516,12 @@ def get_bundle(tag):
"5mpy": (
"https://github.com/adafruit/Adafruit_CircuitPython_Bundle"
"/releases/download"
"/{tag}/adafruit-circuitpython-bundle-5.x-mpy-{tag}.zip".format(
tag=tag
)
"/{tag}/adafruit-circuitpython-bundle-5.x-mpy-{tag}.zip".format(tag=tag)
),
"6mpy": (
"https://github.com/adafruit/Adafruit_CircuitPython_Bundle/"
"releases/download"
"/{tag}/adafruit-circuitpython-bundle-6.x-mpy-{tag}.zip".format(
tag=tag
)
"/{tag}/adafruit-circuitpython-bundle-6.x-mpy-{tag}.zip".format(tag=tag)
),
}
click.echo("Downloading latest version information.\n")
@ -554,9 +535,9 @@ def get_bundle(tag):
# pylint: enable=no-member
total_size = int(r.headers.get("Content-Length"))
temp_zip = BUNDLE_ZIP.format(platform)
with click.progressbar(
r.iter_content(1024), length=total_size
) as pbar, open(temp_zip, "wb") as f:
with click.progressbar(r.iter_content(1024), length=total_size) as pbar, open(
temp_zip, "wb"
) as f:
for chunk in pbar:
f.write(chunk)
pbar.update(len(chunk))
@ -607,9 +588,7 @@ def main(verbose): # pragma: no cover
global CPY_VERSION
CPY_VERSION = get_circuitpython_version(device_path)
click.echo(
"Found device at {}, running CircuitPython {}.".format(
device_path, CPY_VERSION
)
"Found device at {}, running CircuitPython {}.".format(device_path, CPY_VERSION)
)
cp_release = requests.get(
"https://github.com/adafruit/circuitpython/releases/latest", timeout=2
@ -648,9 +627,7 @@ def freeze(requirement): # pragma: no cover
cwd = os.path.abspath(os.getcwd())
for i, module in enumerate(output):
output[i] += "\n"
with open(
cwd + "/" + "requirements.txt", "w", newline="\n"
) as file:
with open(cwd + "/" + "requirements.txt", "w", newline="\n") as file:
file.truncate(0)
file.writelines(output)
else:
@ -676,8 +653,7 @@ def list(): # pragma: no cover
dashes = tuple(("-" * (width - 1) for width in col_width))
data.insert(1, dashes)
click.echo(
"The following modules are out of date or probably need "
"an update.\n"
"The following modules are out of date or probably need " "an update.\n"
)
for row in data:
output = ""
@ -721,9 +697,7 @@ def update(all): # pragma: no cover
except Exception as ex:
logger.exception(ex)
click.echo(
"Something went wrong, {} (check the logs)".format(
str(ex)
)
"Something went wrong, {} (check the logs)".format(str(ex))
)
# pylint: enable=broad-except
else:
@ -789,14 +763,10 @@ def install_module(name, py, mod_names): # pragma: no cover
shutil.copyfile(source_path, target_path)
else:
# Use pre-compiled mpy modules.
module_name = os.path.basename(metadata["path"]).replace(
".py", ".mpy"
)
module_name = os.path.basename(metadata["path"]).replace(".py", ".mpy")
if not module_name:
# Must be a directory based module.
module_name = os.path.basename(
os.path.dirname(metadata["path"])
)
module_name = os.path.basename(os.path.dirname(metadata["path"]))
major_version = CPY_VERSION.split(".")[0]
bundle_platform = "{}mpy".format(major_version)
bundle_path = ""

7
docs/conf.py
View file

@ -73,4 +73,9 @@ html_theme_options = {
"page_width": "1200px",
}
html_sidebars = {"**": ["about.html", "searchbox.html",]}
html_sidebars = {
"**": [
"about.html",
"searchbox.html",
]
}

4
make/make.py
View file

@ -167,12 +167,10 @@ def tidy(*tidy_args):
Run black against the code and tests.
"""
print("\nTidy code")
args = (BLACK, "-l", "79", "circup.py")
args = (BLACK, "--target-version", "py35", ".")
result = subprocess.run(args).returncode
if result > 0:
return result
args = (BLACK, "-l", "79", "tests")
return subprocess.run(args).returncode
@export

49
tests/test_circup.py
View file

@ -131,9 +131,7 @@ def test_Module_row():
bundle_version = None
bundle_path = os.path.join("baz", "bar", "foo", "module.py")
with mock.patch("circup.os.path.isfile", return_value=True):
m = circup.Module(
path, repo, device_version, bundle_version, bundle_path
)
m = circup.Module(path, repo, device_version, bundle_version, bundle_path)
assert m.row == ("module", "1.2.3", "unknown")
@ -222,9 +220,7 @@ def test_find_device_posix_no_mount_command():
with open("tests/mount_exists.txt", "rb") as fixture_file:
fixture = fixture_file.read()
mock_check = mock.MagicMock(side_effect=[FileNotFoundError, fixture])
with mock.patch("os.name", "posix"), mock.patch(
"circup.check_output", mock_check
):
with mock.patch("os.name", "posix"), mock.patch("circup.check_output", mock_check):
assert circup.find_device() == "/media/ntoll/CIRCUITPY"
assert mock_check.call_count == 2
assert mock_check.call_args_list[0][0][0] == "mount"
@ -299,8 +295,7 @@ def test_get_latest_tag():
"/Adafruit_CircuitPython_Bundle/releases/tag/20190903"
)
expected_url = (
"https://github.com/adafruit/Adafruit_CircuitPython_Bundle"
"/releases/latest"
"https://github.com/adafruit/Adafruit_CircuitPython_Bundle" "/releases/latest"
)
with mock.patch("circup.requests.get", return_value=response) as mock_get:
result = circup.get_latest_tag()
@ -320,9 +315,7 @@ def test_extract_metadata_python():
'print("Hello, world!")\n'
)
path = "foo.py"
with mock.patch(
"builtins.open", mock.mock_open(read_data=code)
) as mock_open:
with mock.patch("builtins.open", mock.mock_open(read_data=code)) as mock_open:
result = circup.extract_metadata(path)
mock_open.assert_called_once_with(path, encoding="utf-8")
assert len(result) == 3
@ -384,9 +377,7 @@ def test_get_bundle_versions():
dirs = (("foo/bar/lib", "", ""),)
with mock.patch("circup.ensure_latest_bundle"), mock.patch(
"circup.os.walk", return_value=dirs
) as mock_walk, mock.patch(
"circup.get_modules", return_value="ok"
) as mock_gm:
) as mock_walk, mock.patch("circup.get_modules", return_value="ok") as mock_gm:
assert circup.get_bundle_versions() == "ok"
mock_walk.assert_called_once_with(circup.BUNDLE_DIR.format("py"))
mock_gm.assert_called_once_with("foo/bar/lib")
@ -405,18 +396,16 @@ def test_get_circuitpython_version():
device_path = "device"
with mock.patch("builtins.open", mock_open):
assert circup.get_circuitpython_version(device_path) == "4.1.0"
mock_open.assert_called_once_with(
os.path.join(device_path, "boot_out.txt")
)
mock_open.assert_called_once_with(os.path.join(device_path, "boot_out.txt"))
def test_get_device_versions():
"""
Ensure get_modules is called with the path for the attached device.
"""
with mock.patch(
"circup.find_device", return_value="CIRCUITPYTHON"
), mock.patch("circup.get_modules", return_value="ok") as mock_gm:
with mock.patch("circup.find_device", return_value="CIRCUITPYTHON"), mock.patch(
"circup.get_modules", return_value="ok"
) as mock_gm:
assert circup.get_device_versions() == "ok"
mock_gm.assert_called_once_with(os.path.join("CIRCUITPYTHON", "lib"))
@ -446,9 +435,7 @@ def test_get_modules_that_are_files():
assert result["local_module"]["path"] == os.path.join(
"tests", "local_module.py"
)
assert (
result["local_module"]["__version__"] == "1.2.3"
) # from fixture.
assert result["local_module"]["__version__"] == "1.2.3" # from fixture.
repo = "https://github.com/adafruit/SomeLibrary.git" # from fixture.
assert result["local_module"]["__repo__"] == repo
@ -467,15 +454,11 @@ def test_get_modules_that_are_directories():
"tests/dir_module/my_module.py",
"tests/dir_module/__init__.py",
]
with mock.patch(
"circup.glob.glob", side_effect=[[], [], mods, mod_files, []]
):
with mock.patch("circup.glob.glob", side_effect=[[], [], mods, mod_files, []]):
result = circup.get_modules(path)
assert len(result) == 1
assert "dir_module" in result
assert result["dir_module"]["path"] == os.path.join(
"tests", "dir_module", ""
)
assert result["dir_module"]["path"] == os.path.join("tests", "dir_module", "")
assert result["dir_module"]["__version__"] == "3.2.1" # from fixture.
repo = "https://github.com/adafruit/SomeModule.git" # from fixture.
assert result["dir_module"]["__repo__"] == repo
@ -492,15 +475,11 @@ def test_get_modules_that_are_directories_with_no_metadata():
"tests/bad_module/my_module.py",
"tests/bad_module/__init__.py",
]
with mock.patch(
"circup.glob.glob", side_effect=[[], [], mods, mod_files, []]
):
with mock.patch("circup.glob.glob", side_effect=[[], [], mods, mod_files, []]):
result = circup.get_modules(path)
assert len(result) == 1
assert "bad_module" in result
assert result["bad_module"]["path"] == os.path.join(
"tests", "bad_module", ""
)
assert result["bad_module"]["path"] == os.path.join("tests", "bad_module", "")
assert "__version__" not in result["bad_module"]
assert "__repo__" not in result["bad_module"]