Put the virtualenv into a .venv directory instead of the project root (#1334)

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

.github/workflows/ci.yml

@@ -60,7 +60,7 @@ jobs:
         run: make docs
 
       - name: Run tests
-        run: bin/python manage.py test --verbosity=2 --noinput
+        run: .venv/bin/python manage.py test --verbosity=2 --noinput
         env:
           SCANCODEIO_DB_NAME: ${{ env.POSTGRES_DB }}
           SCANCODEIO_DB_USER: ${{ env.POSTGRES_USER }}

.gitignore

@@ -43,7 +43,8 @@ share
 selenium
 local
 /dist/
-/.cache/
+/.*cache/
+/.venv/
 /.python-version
 /.pytest_cache/
 /scancodeio.egg-info/

Dockerfile

@@ -29,7 +29,7 @@ LABEL org.opencontainers.image.licenses="Apache-2.0"
 ENV APP_NAME scancodeio
 ENV APP_USER app
 ENV APP_DIR /opt/$APP_NAME
-ENV VIRTUAL_ENV /opt/$APP_NAME/venv
+ENV VENV_LOCATION /opt/$APP_NAME/.venv
 
 # Force Python unbuffered stdout and stderr (they are flushed to terminal immediately)
 ENV PYTHONUNBUFFERED 1
@@ -78,9 +78,9 @@ WORKDIR $APP_DIR
 USER $APP_USER
 
 # Create the virtualenv
-RUN python -m venv $VIRTUAL_ENV
+RUN python -m venv $VENV_LOCATION
 # Enable the virtualenv, similar effect as "source activate"
-ENV PATH $VIRTUAL_ENV/bin:$PATH
+ENV PATH $VENV_LOCATION/bin:$PATH
 
 # Create static/ and workspace/ directories
 RUN mkdir -p /var/$APP_NAME/static/ \

Makefile

@@ -22,8 +22,9 @@
 
 # Python version can be specified with `$ PYTHON_EXE=python3.x make conf`
 PYTHON_EXE?=python3
-MANAGE=bin/python manage.py
-ACTIVATE?=. bin/activate;
+VENV_LOCATION=.venv
+ACTIVATE?=. ${VENV_LOCATION}/bin/activate;
+MANAGE=${VENV_LOCATION}/bin/python manage.py
 VIRTUALENV_PYZ=etc/thirdparty/virtualenv.pyz
 # Do not depend on Python to generate the SECRET_KEY
 GET_SECRET_KEY=`head -c50 /dev/urandom | base64 | head -c50`
@@ -46,7 +47,7 @@ endif
 
 virtualenv:
 	@echo "-> Bootstrap the virtualenv with PYTHON_EXE=${PYTHON_EXE}"
-	@${PYTHON_EXE} ${VIRTUALENV_PYZ} --never-download --no-periodic-update .
+	@${PYTHON_EXE} ${VIRTUALENV_PYZ} --never-download --no-periodic-update ${VENV_LOCATION}
 
 conf: virtualenv
 	@echo "-> Install dependencies"
@@ -85,8 +86,8 @@ check-deploy:
 
 clean:
 	@echo "-> Clean the Python env"
-	rm -rf bin/ lib/ lib64/ include/ build/ dist/ docs/_build/ .cache/ pip-selfcheck.json pyvenv.cfg
-	find . -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete -type d -name '*.egg-info' -delete
+	rm -rf .venv/ .*_cache/ *.egg-info/ build/ dist/
+	find . -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete
 
 migrate:
 	@echo "-> Apply database migrations"

pyproject.toml

@@ -1,15 +1,7 @@
 [tool.ruff]
 line-length = 88
-exclude = [
-    "migrations",
-    "bin",
-    "Script",
-    "Lib",
-    "lib",
-    "lib64",
-    "local",
-    "var",
-]
+extend-exclude = ["migrations", "var"]
+target-version = "py310"
 
 [tool.ruff.lint]
 # Rules: https://docs.astral.sh/ruff/rules/
@@ -41,5 +33,6 @@ section-order = [
 max-complexity = 10
 
 [tool.ruff.lint.per-file-ignores]
-# All usage of assert on the SPDX test file.
+# Allow the usage of assert in the test_spdx file.
 "**/test_spdx.py*" = ["S101"]
+"scanpipe/pipes/spdx.py" = ["UP006", "UP035"]

scanpipe/forms.py

@@ -47,7 +47,7 @@ def __init__(self, *args, **kwargs):
 
     def clean(self, data, initial=None):
         single_file_clean = super().clean
-        if isinstance(data, (list, tuple)):
+        if isinstance(data, list | tuple):
             result = [single_file_clean(entry, initial) for entry in data]
         else:
             result = single_file_clean(data, initial)

scanpipe/models.py

@@ -930,7 +930,7 @@ def inputs(self, pattern="**/*", extensions=None):
         if not extensions:
             return self.input_path.glob(pattern)
 
-        if not isinstance(extensions, (list, tuple)):
+        if not isinstance(extensions, list | tuple):
             raise TypeError("extensions should be a list or tuple")
 
         return (

scanpipe/pipes/output.py

@@ -413,7 +413,7 @@ def _adapt_value_for_xlsx(fieldname, value, maximum_length=32767, _adapt=True):
         value = [mapping[mapping_key] for mapping in value]
 
     # convert these to text lines, remove duplicates
-    if isinstance(value, (list, tuple)):
+    if isinstance(value, list | tuple):
         value = ordered_unique(str(v) for v in value if v)
         value = "\n".join(value)
 

scanpipe/tests/test_pipelines.py

@@ -594,7 +594,7 @@ def _normalize_package_uids(self, data):
                 is_local_files = True
             normalized_data = {}
             for key, value in data.items():
-                if isinstance(value, (list, dict)):
+                if isinstance(value, list | dict):
                     value = self._normalize_package_uids(value)
                 if key in fields_with_package_uids and value:
                     value = purl_with_fake_uuid(value)

scanpipe/views.py

@@ -327,7 +327,7 @@ def get_field_value(self, field_name, render_func=None):
         if isinstance(field_value, Manager):
             return list(field_value.all())
 
-        if isinstance(field_value, (list, dict)):
+        if isinstance(field_value, list | dict):
             with suppress(Exception):
                 field_value = render_as_yaml(field_value)