Try to improve version detection in python code

Author: libre-man

MANIFEST.in

@@ -1,3 +1,4 @@
 include debian/patches/fix-cgfs_types
 include debian/patches/fix-fusepy
 include debian/patches/series
+include package.json

Makefile

@@ -70,16 +70,17 @@ test-quick: test
 check: check-format mypy lint test
 
 .PHONY: build
-build: install-deps check build-$(UNAME)
+build: install check build-$(UNAME)
 
 .PHONY: build-quick
-build-quick: install-deps build-$(UNAME)
+build-quick: install build-$(UNAME)
 
 dist/cgfs: codegra_fs/*.py
 	pyinstaller \
 		--noconfirm \
 		--onedir \
 		--specpath dist \
+		--additional-hooks-dir=./pyinstaller_hooks \
 		--name cgfs \
 		codegra_fs/cgfs.py
 
@@ -88,6 +89,7 @@ dist/cgapi-consumer: codegra_fs/*.py
 		--noconfirm \
 		--onedir \
 		--specpath dist \
+		--additional-hooks-dir=./pyinstaller_hooks \
 		--name cgapi-consumer \
 		codegra_fs/api_consumer.py
 

build.py

@@ -5,7 +5,6 @@
 import subprocess
 
 import requests
-from codegra_fs import __version__
 
 BASE_DIR = os.path.dirname(os.path.realpath(__file__))
 os.chdir(BASE_DIR)
@@ -19,6 +18,7 @@ def pyinstaller(module, name):
             'pyinstaller',
             '--noconfirm',
             '--onedir',
+            '--additional-hooks-dir=./pyinstaller_hooks',
             '--specpath',
             'dist',
             '--name',

codegra_fs/__init__.py

@@ -1,6 +1,26 @@
 # SPDX-License-Identifier: AGPL-3.0-only
 
-__version__ = (1, 1, 2)
+import sys
+import typing as t
+
+import pkg_resources
+import packaging.version
+
+if t.TYPE_CHECKING:
+    from typing_extensions import Final, Literal
+
+__version__ = 'UNKNOWN'  # type: t.Union['Literal["UNKNOWN"]', packaging.version.Version]
+try:
+    __version__ = packaging.version.Version(
+        pkg_resources.get_distribution('codegrade-fs').version
+    )
+except:
+    import traceback
+    print('Could not read version:', file=sys.stderr)
+    traceback.print_exc()
+finally:
+    del pkg_resources
+
 __author__ = 'Olmo Kramer, Thomas Schaper'
 __email__ = 'info@CodeGra.de'
 __license__ = 'AGPL-3.0-only'

codegra_fs/cgapi.py

@@ -9,7 +9,6 @@
 from urllib.parse import quote
 
 import requests
-
 import codegra_fs
 
 DEFAULT_CGAPI_BASE_URL = os.getenv(
@@ -18,9 +17,7 @@
 
 T_CALL = t.TypeVar('T_CALL', bound=t.Callable)
 
-USER_AGENT = 'CodeGradeFS/{}'.format(
-    '.'.join(map(str, codegra_fs.__version__))
-)
+USER_AGENT = 'CodeGradeFS/{}'.format(codegra_fs.__version__)
 
 logger = logging.getLogger(__name__)
 
@@ -117,7 +114,9 @@ def get_file_rename(self, file_id, new_path):
         return (
             '{base}/code/{file_id}?operation='
             'rename&new_path={new_path}'
-        ).format(base=self.base, file_id=file_id, new_path=quote(new_path))
+        ).format(
+            base=self.base, file_id=file_id, new_path=quote(new_path)
+        )
 
     def get_submission_feedbacks(self, submission_id):
         return '{base}/submissions/{submission_id}/feedbacks/'.format(
@@ -130,18 +129,21 @@ def get_feedbacks(self, assignment_id):
         )
 
     def get_feedback(self, file_id):
-        return ('{base}/code/{file_id}?type=feedback'
-                ).format(base=self.base, file_id=file_id)
+        return ('{base}/code/{file_id}?type=feedback').format(
+            base=self.base, file_id=file_id
+        )
 
     def add_feedback(self, file_id, line):
-        return ('{base}/code/{file_id}/comments/{line}'
-                ).format(base=self.base, file_id=file_id, line=line)
+        return ('{base}/code/{file_id}/comments/{line}').format(
+            base=self.base, file_id=file_id, line=line
+        )
 
     delete_feedback = add_feedback
 
     def get_assignment(self, assignment_id):
-        return ('{base}/assignments/{assignment_id}'
-                ).format(base=self.base, assignment_id=assignment_id)
+        return ('{base}/assignments/{assignment_id}').format(
+            base=self.base, assignment_id=assignment_id
+        )
 
 
 class APICodes(IntEnum):

codegra_fs/cgfs.py

@@ -2481,7 +2481,7 @@ def main() -> None:
         dest='version',
         action='version',
         version=(
-            '%(prog)s {}'.format('.'.join(map(str, codegra_fs.__version__)))
+            '%(prog)s {}'.format(codegra_fs.__version__)
         ),
         help='Display version.',
     )

codegra_fs/utils.py

@@ -7,6 +7,7 @@
 
 import requests
 import codegra_fs
+import packaging.version
 
 T = t.TypeVar('T')
 Y = t.TypeVar('Y')
@@ -63,13 +64,18 @@ def get_fuse_install_message() -> t.Optional[t.Tuple[str, t.Optional[str]]]:
 
 
 def newer_version_available() -> bool:
+    my_version = codegra_fs.__version__
+    # The isinstance check is needed for mypy
+    if isinstance(my_version, str) and my_version == 'UNKNOWN':
+        return False
+
     try:
         req = requests.get('https://fs.codegrade.com/.cgfs.json', timeout=2)
         req.raise_for_status()
-        latest = tuple(map(int, req.json()['version']))
+        latest = packaging.version.Version('.'.join(req.json()['version']))
+        return my_version < latest
     except:
         return False
-    return latest > codegra_fs.__version__
 
 
 def find_all_dups(

pyinstaller_hooks/hook-codegra_fs.py

@@ -0,0 +1,3 @@
+from PyInstaller.utils.hooks import copy_metadata
+
+datas = copy_metadata('codegrade-fs')

requirements.txt

@@ -6,3 +6,4 @@ pylint>=2.3.1
 pytest>=4.4.1
 requests>=2.20.0
 yapf>=0.27.0
+packaging>=20.8

setup.py

@@ -1,12 +1,16 @@
 #!/usr/bin/env python3
 
+import os
 import sys
+import json
 
+import packaging.version
 from setuptools import setup
 
-import codegra_fs
-
-version = '.'.join(map(str, codegra_fs.__version__))
+with open(os.path.join(os.path.dirname(__file__), 'package.json')) as f:
+    version = json.load(f)['version']
+    # Make sure we can parse this version
+    packaging.version.Version(version)
 
 if sys.version_info < (3, 5):
     print('Sorry only python 3.5 and up is supported', file=sys.stderr)
@@ -15,6 +19,7 @@
 requires = [
     'requests>=2.20.0',
     'fusepy>3.0.0,<4.0.0',
+    'packaging>=20.8',
 ]
 if sys.platform.startswith('win32'):
     requires += [