chore: versioneer-compatible versions #2038

aarnphm · 2021-11-22T04:51:23Z

Signed-off-by: Aaron Pham [email protected]

Maybe i spent way too much time writing stubs :)

Signed-off-by: Aaron Pham <[email protected]>

codecov · 2021-11-22T04:53:30Z

Codecov Report

Merging #2038 (a2abcbc) into bentoml-1.0 (ddbebc4) will decrease coverage by 37.15%.
The diff coverage is 93.75%.

❗ Current head a2abcbc differs from pull request most recent head 52887ec. Consider uploading reports for the commit 52887ec to get more accurate results

@@               Coverage Diff                @@
##           bentoml-1.0    #2038       +/-   ##
================================================
- Coverage        81.75%   44.60%   -37.16%     
================================================
  Files               22       95       +73     
  Lines             1864     6548     +4684     
================================================
+ Hits              1524     2921     +1397     
- Misses             340     3627     +3287

Flag	Coverage Δ
e2e-tests	`17.27% <87.50%> (?)`
frameworks	`81.75% <ø> (ø)`
unit-tests	`20.29% <93.75%> (?)`

Impacted Files	Coverage Δ
bentoml/_internal/configuration/__init__.py	`73.68% <84.61%> (ø)`
bentoml/_internal/configuration/containers.py	`63.02% <100.00%> (ø)`
bentoml/_internal/marshal/dispatcher.py	`0.00% <0.00%> (ø)`
bentoml/_internal/utils/validation.py	`80.00% <0.00%> (ø)`
bentoml/_internal/io_descriptors/json.py	`52.77% <0.00%> (ø)`
bentoml/_internal/bento/env.py	`86.36% <0.00%> (ø)`
bentoml/_internal/bento/local_py_modules.py	`0.00% <0.00%> (ø)`
bentoml/_internal/store.py	`85.36% <0.00%> (ø)`
bentoml/_internal/tracing/noop.py	`0.00% <0.00%> (ø)`
bentoml/_internal/server/runner_app.py	`0.00% <0.00%> (ø)`
... and 65 more

Signed-off-by: Aaron Pham <[email protected]>

pyproject.toml

parano · 2021-11-22T07:42:13Z

bentoml/_internal/configuration/__init__.py

@@ -42,7 +42,7 @@ def expand_env_var(env_var):


 def is_pip_installed_bentoml():
-    is_installed_package = hasattr(version_mod, "version_json")
+    is_installed_package = len(version_mod.version_tuple) == 3


~~we will start with pre-release on pypi which will break this, pre-release looks like 1.0.0.a2~~

:) it shouldn't

tried building a pre-release with 1.0.0.a2 and bentoml._version.version_tuple == (1,0,0) after pip install, so it's working as expected.

I do run into another case, where after I tag the branch with any string in semver format, it will think it's a pypi released version, even if it's a editable install

parano · 2021-11-22T07:55:33Z

bentoml/_internal/configuration/__init__.py

@@ -42,7 +42,7 @@ def expand_env_var(env_var):


 def is_pip_installed_bentoml():
-    is_installed_package = hasattr(version_mod, "version_json")
+    is_installed_package = len(version_mod.version_tuple) == 3
    is_tagged = not BENTOML_VERSION.startswith("0+untagged")


we will also need to change this to not BENTOML_VERSION.startswith("0.1.") - looks like setuptools_scm will generate versions like 0.1.dev1392+gddbebc4 when there is no tag

Signed-off-by: Aaron Pham <[email protected]>

… into fix/ci_scripts Signed-off-by: Aaron Pham <[email protected]>

Signed-off-by: Aaron Pham <[email protected]>

pep8speaks · 2021-11-22T12:14:32Z

Hello @aarnphm, Thanks for updating this PR.

There are currently no PEP 8 issues detected in this PR. Cheers! 🍻

Comment last updated at 2021-11-22 15:10:48 UTC

Signed-off-by: Aaron Pham <[email protected]>

parano · 2021-11-22T17:58:45Z

MANIFEST.in

@@ -2,6 +2,10 @@ include README.md
 include LICENSE

 # Included in PyPI distribution
+include bentoml/*.py


@aarnphm these lines here are not needed

all files tracked by git is already included by default, now with setuptools scm

parano · 2021-11-22T18:02:10Z

bentoml/_internal/configuration/__init__.py

+try:
+    import bentoml._version as version_mod
+except ImportError:
+    # Since we aren't VCS _version.py, which is generated by setuptools_scm


when will this happen?

I suppose only when a developer does pip install -e . and then removed the _version.py file by accident?

yes. Also mainly for type checking where pyright cannot find bentoml._version.
There is also a current caveats with types CI atm

parano · 2021-11-22T18:04:32Z

bentoml/_internal/configuration/__init__.py

    if CONFIG_ENV_VAR in os.environ:
        # User local config file for customizing bentoml
-        return expand_env_var(os.environ.get(CONFIG_ENV_VAR))
+        return expand_env_var(os.environ[CONFIG_ENV_VAR])


this will raise a keyerror if the env var is not set

could you also make this change in the follow-up pr?

parano · 2021-11-22T18:05:43Z

bentoml/_internal/configuration/containers.py

-            "type": Or(
-                And(str, Use(str.lower), lambda s: s in ("zipkin", "jaeger")), None
-            ),
+            "type": Or(And(str, Use(str.lower), _check_tracing_type), None),


this case is better left it is, easier to read in context

This mainly to compensate pyright :(

can't believe there's no easy way to type a lambda function inline :(

parano · 2021-11-22T18:07:24Z

bentoml/_internal/configuration/containers.py

@@ -219,14 +223,17 @@ def tracer(

            return NoopTracer()

-    logging_file_directory = providers.Factory(
-        lambda default, customized: customized or default,
+    logging_file_directory = t.cast(


@bojiang could you review this part?

lol it should not be like this

simple_di can't be inferred by pyright

parano · 2021-11-22T18:09:37Z

scripts/ci/style/pylint_check.sh

+    exit 1
+  fi
+else
+  echo "Running pylint for the whole library..."


also I think pylint is failing on main branch now, for the same reason pyright was failing before

We can just disable pylint for running on the main branch then

aarnphm added 2 commits November 21, 2021 23:07

chore: restore versioneer

4d379c2

Signed-off-by: Aaron Pham <[email protected]>

feat: versioneer compatible for PEP518

d31a3cf

Signed-off-by: Aaron Pham <[email protected]>

chore: remove versioneer

19da3a7

Signed-off-by: Aaron Pham <[email protected]>

aarnphm changed the title ~~chore: restore versioneer~~ chore: versioneer-compatible versions Nov 22, 2021

aarnphm added 2 commits November 22, 2021 01:02

chore: setuptools_scm

c60f06a

Signed-off-by: Aaron Pham <[email protected]>

fix: move away from alpine image

1c9ff20

Signed-off-by: Aaron Pham <[email protected]>

parano reviewed Nov 22, 2021

View reviewed changes

pyproject.toml Outdated Show resolved Hide resolved

parano reviewed Nov 22, 2021

View reviewed changes

Merge branch 'bentoml-1.0' into fix/ci_scripts

6b7bc79

parano reviewed Nov 22, 2021

View reviewed changes

aarnphm added 3 commits November 22, 2021 07:05

fix: CI type hint, took me way too long

14331f8

Signed-off-by: Aaron Pham <[email protected]>

refactor: Merge branch 'fix/ci_scripts' of github.com:aarnphm/BentoML…

74f008b

… into fix/ci_scripts Signed-off-by: Aaron Pham <[email protected]>

chore: debug codestyle check

a985e3b

Signed-off-by: Aaron Pham <[email protected]>

aarnphm added 4 commits November 22, 2021 07:25

fix: codecov wrong reports

03a9706

Signed-off-by: Aaron Pham <[email protected]>

chore(build/docs): patch rtd builds

c7e16e2

Signed-off-by: Aaron Pham <[email protected]>

perf: cache pulling images

1675cd6

Signed-off-by: Aaron Pham <[email protected]>

fix: CI

c84fdb6

Signed-off-by: Aaron Pham <[email protected]>

aarnphm force-pushed the fix/ci_scripts branch 2 times, most recently from e72acea to c84fdb6 Compare November 22, 2021 12:51

aarnphm added 6 commits November 22, 2021 07:55

fix: CI

429b182

Signed-off-by: Aaron Pham <[email protected]>

fix: cache docker images

8e01a46

Signed-off-by: Aaron Pham <[email protected]>

fix: docker permission for ci-pyright

10dcb19

Signed-off-by: Aaron Pham <[email protected]>

fix(ci): correct type

ffe550a

Signed-off-by: Aaron Pham <[email protected]>

chore: enable pylint

bfba2d7

Signed-off-by: Aaron Pham <[email protected]>

fix: build errors

a2abcbc

Signed-off-by: Aaron Pham <[email protected]>

aarnphm force-pushed the fix/ci_scripts branch from 2b6091e to a2abcbc Compare November 22, 2021 14:58

chore(ci): add track changes for Docker checker scripts cache

52887ec

Signed-off-by: Aaron Pham <[email protected]>

aarnphm merged commit dc17592 into bentoml:bentoml-1.0 Nov 22, 2021

aarnphm deleted the fix/ci_scripts branch November 22, 2021 15:12

parano reviewed Nov 22, 2021

View reviewed changes

aarnphm added a commit to aarnphm/BentoML that referenced this pull request Jul 29, 2022

chore: versioneer-compatible versions (bentoml#2038)

4a0c030

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: versioneer-compatible versions #2038

chore: versioneer-compatible versions #2038

aarnphm commented Nov 22, 2021 •

edited

Loading

codecov bot commented Nov 22, 2021 •

edited

Loading

parano Nov 22, 2021 •

edited

Loading

aarnphm Nov 22, 2021

parano Nov 22, 2021

parano Nov 22, 2021

aarnphm Nov 22, 2021

pep8speaks commented Nov 22, 2021 •

edited

Loading

parano Nov 22, 2021

parano Nov 22, 2021

aarnphm Nov 22, 2021

parano Nov 22, 2021

aarnphm Nov 22, 2021

parano Nov 22, 2021

parano Nov 22, 2021

parano Nov 22, 2021

aarnphm Nov 22, 2021

parano Nov 22, 2021

parano Nov 22, 2021

bojiang Nov 22, 2021

bojiang Nov 22, 2021

aarnphm Nov 22, 2021

parano Nov 22, 2021

aarnphm Nov 22, 2021

chore: versioneer-compatible versions #2038

chore: versioneer-compatible versions #2038

Conversation

aarnphm commented Nov 22, 2021 • edited Loading

codecov bot commented Nov 22, 2021 • edited Loading

Codecov Report

parano Nov 22, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pep8speaks commented Nov 22, 2021 • edited Loading

Comment last updated at 2021-11-22 15:10:48 UTC

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aarnphm commented Nov 22, 2021 •

edited

Loading

codecov bot commented Nov 22, 2021 •

edited

Loading

parano Nov 22, 2021 •

edited

Loading

pep8speaks commented Nov 22, 2021 •

edited

Loading