GH45 - add xts alias rework #52

zghp · 2026-01-09T11:27:47Z

No description provided.

github-actions · 2026-01-09T11:27:56Z

Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

I have read the CLA Document and I hereby sign the CLA

1 out of 2 committers have signed the CLA.
✅ (TB-1993)[https://github.com/TB-1993]
❌ @zghp
zghp seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
_{You can retrigger this bot by commenting recheck in this Pull Request.}_{Posted by the CLA Assistant Lite bot.}

rdkcmf-jenkins · 2026-01-09T11:28:42Z

b'## Blackduck scan failure details

Summary: 0 violations, 0 files pending approval, 1 file pending identification.

Protex Server Path: /home/blackduck/github/xts_core/52/rdkcentral/xts_core
Commit: 9db6372

Report detail: gist'

Copilot

Pull request overview

This PR significantly refactors the XTS alias management system to support multiple input types (URLs, files, and directories) with improved caching and a cleaner CLI interface.

Key changes:

Rewrote alias management to handle URLs, single files, and directories of .xts files
Changed CLI from xts alias subcommands to xts --alias flag-based interface
Simplified the main XTS class by removing auto-discovery of .xts files in favor of explicit alias resolution
Introduced hash-based cache naming to avoid file collisions

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 10 comments.

File	Description
src/xts_core/xts_alias.py	Complete rewrite with new helper functions, improved caching logic, directory support, and CLI handler
src/xts_core/xts.py	Removed old alias subcommand parsing, removed auto-discovery, simplified to use alias-only workflow with new help system

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-09T11:31:25Z

src/xts_core/xts_alias.py

    ensure_dirs()
-    filename = hashlib.sha256(url.encode()).hexdigest() + ".xts"
-    path = os.path.join(CACHE_DIR, filename)
-
-    if not os.path.exists(path):
-        print(f"Fetching remote .xts config from: {url}")
-        r = requests.get(url)
-        r.raise_for_status()
-        with open(path, "w", encoding="utf-8") as f:
-            f.write(r.text)
+    # filename = hashlib.sha256(url.encode()).hexdigest() + ".xts"
+    filename = Path(urlparse(url).path).name
+    if not filename:
+        raise ValueError(f"URL does not contain a filename: {url}")
+
+    cached_path = os.path.join(CACHE_DIR, filename)
+
+    print(f"Fetching remote .xts config from: {url}")
+    r = requests.get(url)
+    r.raise_for_status()
+
+    with open(cached_path, "w", encoding="utf-8") as f:
+        f.write(r.text)

-    return path
+    return cached_path


The fetch_url_to_cache function now always re-downloads the file even if it already exists in cache (the if not os.path.exists(path) check was removed). This could lead to unnecessary network requests and slower performance. Consider adding back a check to skip downloading if the file already exists, or add a force parameter to control this behavior.

src/xts_core/xts_alias.py

src/xts_core/xts.py

Copilot · 2026-01-09T11:31:26Z

src/xts_core/xts_alias.py

+
+def _cache_name_for_local_file(src: Path) -> str:
+    """
+    Produce a stable cache filename for a local file, avoiding collisoins


Spelling error: "collisoins" should be "collisions".

Suggested change

Produce a stable cache filename for a local file, avoiding collisoins

Produce a stable cache filename for a local file, avoiding collisions

Copilot · 2026-01-09T11:31:26Z

src/xts_core/xts_alias.py

+    cache_name = _cache_name_for_local_file(src)
+    dst = Path(CACHE_DIR) / cache_name
+
+    shutil.copy2(src, dst)  #ovewrite to refresh


Spelling error: "#ovewrite" should be "# overwrite" (missing space after #).

Suggested change

shutil.copy2(src, dst) #ovewrite to refresh

shutil.copy2(src, dst) # overwrite to refresh

Copilot · 2026-01-09T11:31:27Z

src/xts_core/xts_alias.py

+    if remove_name is not None:
+        removed = remove_alias(remove_name)
+        if removed:
+            print(f"Removed alias: {remove_name}")
+            return 0
+        print(f"Alias not found: {remove_name}")
+        return 2


The variable 'removed' is assigned the return value of remove_alias(), but remove_alias() returns None. This check will always fail. The logic should be revised to check whether the alias exists before attempting removal, or the remove_alias function should return a boolean.

src/xts_core/xts_alias.py

Copilot · 2026-01-09T11:31:27Z

src/xts_core/xts_alias.py

+def remove_alias(name: str) -> None:
+    """
+    Remove an alias if it exists.
+    """
+    aliases = load_aliases()
    if name in aliases:
        del aliases[name]
-    with open(ALIAS_FILE, "w") as f:
-        json.dump(aliases, f, indent=2)
+        save_aliases(aliases)


The remove_alias function returns None in all cases, but the calling code checks if the return value is truthy (line 340). This will always evaluate to False, making the success message unreachable. The function should return True when an alias is removed or False when it doesn't exist.

Copilot · 2026-01-09T11:31:27Z

src/xts_core/xts.py

+        if not resolved_xts_path:
+            error(f"Alias '{alias_name}' not found. Add it via: xts --alias <path|url|dir> [--name <name>]")
+
+        # laod xts config remove alias name from argv before parsing


Spelling error: "laod" should be "load".

Suggested change

# laod xts config remove alias name from argv before parsing

# load xts config remove alias name from argv before parsing

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot · 2026-01-14T11:46:10Z

src/xts_core/xts_alias.py

    from xts_core import utils

+try:
+    from  .xts_arg_parser import XTSArgumentParser


Extra space between 'from' and '.xts_arg_parser'. Should be 'from .xts_arg_parser import XTSArgumentParser'.

Suggested change

from .xts_arg_parser import XTSArgumentParser

from .xts_arg_parser import XTSArgumentParser

Copilot · 2026-01-14T11:46:10Z

src/xts_core/xts_alias.py

+
+def _cache_name_for_local_file(src: Path) -> str:
+    """
+    Produce a stable cache filename for a local file, avoiding collisoins


Corrected spelling of 'collisoins' to 'collisions'.

Suggested change

Produce a stable cache filename for a local file, avoiding collisoins

Produce a stable cache filename for a local file, avoiding collisions

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 20 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-01-19T11:53:44Z

src/xts_core/xts_alias.py

    os.makedirs(CACHE_DIR, exist_ok=True)
    os.makedirs(os.path.dirname(ALIAS_FILE), exist_ok=True)

+# move these to utils


The comment on line 60 "move these to utils" suggests these helper functions should be relocated. If the intention is to move _is_url to the existing utils.is_url function, this creates duplication. The existing utils.is_url uses a simpler string startswith check, while _is_url uses urlparse with more robust validation. Consider consolidating these into a single implementation in utils.py or removing the comment if the functions should remain here.

Suggested change

# move these to utils

# Local helper functions; _is_url intentionally differs from utils.is_url

# (uses urllib.parse.urlparse for stricter URL validation).

Copilot · 2026-01-19T11:53:44Z

src/xts_core/xts_alias.py

+                              action='store',
+                              default=None,
+                              help='URI of xts file to add alias of',
+                              nargs=argparse.OPTIONAL)


The nargs=argparse.OPTIONAL should be nargs='?' for an optional positional argument in argparse. argparse.OPTIONAL is not a valid constant; the correct value is the string '?'.

Suggested change

nargs=argparse.OPTIONAL)

nargs='?')

Copilot · 2026-01-19T11:53:44Z

src/xts_core/xts_alias.py

+    cache_name = _cache_name_for_local_file(src)
+    dst = Path(CACHE_DIR) / cache_name
+
+    shutil.copy2(src, dst)  #overwrite to refresh


The inline comment shows lack of proper spacing around the '#' character. According to PEP 8, there should be at least two spaces before an inline comment and one space between the '#' and the comment text. The comment should be: '# overwrite to refresh'

Suggested change

shutil.copy2(src, dst) #overwrite to refresh

shutil.copy2(src, dst) # overwrite to refresh

Copilot · 2026-01-19T11:53:45Z

src/xts_core/xts_alias.py

+        return True
+    return False
+
+def resolve_alias_to_xts_path(alias_name: str) -> str | None:


The return type annotation 'str | None' uses the Python 3.10+ union syntax. If the project needs to support Python 3.9 or earlier, this should use 'Optional[str]' from the typing module instead. Check the project's Python version requirements to ensure compatibility.

Copilot · 2026-01-19T11:53:45Z

src/xts_core/xts.py

+                remaining_args.append(args.alias)
+            xts_alias.run_alias_builtin(remaining_args)
+            raise SystemExit(0)
+        resolved_xts_path = xts_alias.resolve_alias_to_xts_path(args.alias)


The resolved_xts_path may be None if the alias is not found in resolve_alias_to_xts_path. Setting self.xts_config to None will cause an error in the xts_config setter at line 130 ("xts config specified does not exist"). Consider adding explicit validation and providing a more helpful error message to the user about the unknown alias.

Suggested change

resolved_xts_path = xts_alias.resolve_alias_to_xts_path(args.alias)

resolved_xts_path = xts_alias.resolve_alias_to_xts_path(args.alias)

if resolved_xts_path is None:

# Provide a clear error when the alias cannot be resolved instead of

# passing None into the xts_config setter.

error(

f'Unknown alias "{args.alias}". '

'Use "xts --alias list" to see available aliases.'

)

raise SystemExit(1)

Copilot · 2026-01-19T11:53:48Z

src/xts_core/xts_alias.py

+    cache_name = _cache_name_for_local_file(src)
+    dst = Path(CACHE_DIR) / cache_name
+
+    shutil.copy2(src, dst)  #overwrite to refresh


The comment indicates 'overwrite to refresh', but shutil.copy2 preserves file metadata including modification times from the source. If the intention is to always refresh with the latest source content, this is correct. However, if modification times are important for cache invalidation logic, consider documenting this behavior more explicitly or using shutil.copy instead.

Suggested change

shutil.copy2(src, dst) #overwrite to refresh

shutil.copy(src, dst) # overwrite to refresh cache content and metadata

Copilot · 2026-01-19T11:53:48Z

src/xts_core/xts_alias.py

+    filename = Path(urlparse(url).path).name
+    if not filename:
+        raise ValueError(f"URL does not contain a filename: {url}")
+


The commented-out line suggests the previous implementation used a SHA-256 hash of the URL as the filename. The new implementation uses the actual filename from the URL path. This change creates a potential security issue: filenames from URLs could contain path traversal characters (e.g., "../evil.xts") or other problematic characters. Consider sanitizing the filename or validating that it doesn't contain directory separators before using it.

Suggested change

# Validate that the derived filename cannot be used for path traversal.

if filename in (".", ".."):

raise ValueError(f"URL contains an invalid filename: {url}")

for sep in (os.sep, os.path.altsep):

if sep and sep in filename:

raise ValueError(f"URL contains an invalid filename: {url}")

Copilot · 2026-01-19T11:53:48Z

src/xts_core/xts.py

+            sys.exit(sorted(exit_code)[-1])
+        except Exception as e:
+            error(
+                'An unrecognised command caused an error\n\n'


The error message uses 'An unrecognised command' but the word is misspelled. It should be 'An unrecognized command' (American) or 'An unrecognised command' (British). The codebase appears to use American spelling based on other comments, so 'unrecognized' is preferred.

Copilot · 2026-01-19T11:53:49Z

src/xts_core/xts.py

+    def _parse_first_arg(self):
+        """
+        Parse CLI arguments and set up argparse for all commands.
+        The first argument must be either:
+        - a built-in option starting with '--' (currently supported: --alias)
+        - an alias name (resolved via ~/.xts/aliases.json to an .xts file path)
+        Direct .xts file usage from cwd or as the first argument is not supported.


The docstring states "Direct .xts file usage from cwd or as the first argument is not supported." This is a breaking change from the previous behavior where users could run 'xts file.xts command'. This should be documented in the module docstring or changelog, and error messages should clearly guide users to use aliases instead.

Copilot · 2026-01-19T11:53:49Z

src/xts_core/xts_alias.py

 except:
    from xts_core import utils

+try:
+    from .xts_arg_parser import XTSArgumentParser
+except:


Except block directly handles BaseException.

Suggested change

except:

from xts_core import utils

try:

from .xts_arg_parser import XTSArgumentParser

except:

except ImportError:

from xts_core import utils

try:

from .xts_arg_parser import XTSArgumentParser

except ImportError:

add xts alias rework

9db6372

zghp added this to the xts_core 1.6.0: XTS Project support milestone Jan 9, 2026

zghp requested a review from TB-1993 January 9, 2026 11:27

zghp self-assigned this Jan 9, 2026

zghp requested a review from a team as a code owner January 9, 2026 11:27

Copilot AI review requested due to automatic review settings January 9, 2026 11:27

Copilot started reviewing on behalf of zghp January 9, 2026 11:28 View session

Copilot AI reviewed Jan 9, 2026

View reviewed changes

TB-1993 and others added 2 commits January 12, 2026 16:57

Update #45: Changed parse_first_args to use an ArgumentParser

c327e7c

match xts alias handling with argparse refactor

39a660e

Copilot AI review requested due to automatic review settings January 14, 2026 11:44

Copilot AI reviewed Jan 14, 2026

View reviewed changes

zghp added 2 commits January 19, 2026 11:42

remove choices option from the first argument parser

e6df27b

update remove_alias() to return bool

dcb97f4

Copilot AI review requested due to automatic review settings January 19, 2026 11:46

Copilot started reviewing on behalf of zghp January 19, 2026 11:47 View session

Copilot AI reviewed Jan 19, 2026

View reviewed changes

	Produce a stable cache filename for a local file, avoiding collisoins
	Produce a stable cache filename for a local file, avoiding collisions

	shutil.copy2(src, dst) #ovewrite to refresh
	shutil.copy2(src, dst) # overwrite to refresh

	# laod xts config remove alias name from argv before parsing
	# load xts config remove alias name from argv before parsing

	from .xts_arg_parser import XTSArgumentParser
	from .xts_arg_parser import XTSArgumentParser

	# move these to utils
	# Local helper functions; _is_url intentionally differs from utils.is_url
	# (uses urllib.parse.urlparse for stricter URL validation).

	shutil.copy2(src, dst) #overwrite to refresh
	shutil.copy2(src, dst) # overwrite to refresh

-        resolved_xts_path = xts_alias.resolve_alias_to_xts_path(args.alias)
+        resolved_xts_path = xts_alias.resolve_alias_to_xts_path(args.alias)
+        if resolved_xts_path is None:
+            # Provide a clear error when the alias cannot be resolved instead of
+            # passing None into the xts_config setter.
+            error(
+                f'Unknown alias "{args.alias}". '
+                'Use "xts --alias list" to see available aliases.'
+            )
+            raise SystemExit(1)

	shutil.copy2(src, dst) #overwrite to refresh
	shutil.copy(src, dst) # overwrite to refresh cache content and metadata

+    # Validate that the derived filename cannot be used for path traversal.
+    if filename in (".", ".."):
+        raise ValueError(f"URL contains an invalid filename: {url}")
+    for sep in (os.sep, os.path.altsep):
+        if sep and sep in filename:
+            raise ValueError(f"URL contains an invalid filename: {url}")

GH45 - add xts alias rework #52

Are you sure you want to change the base?

GH45 - add xts alias rework #52

Uh oh!

Conversation

zghp commented Jan 9, 2026

Uh oh!

github-actions bot commented Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rdkcmf-jenkins commented Jan 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 14, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jan 19, 2026

github-actions bot commented Jan 9, 2026 •

edited

Loading