polylith-cli 1.43.0__tar.gz → 1.44.0__tar.gz

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: polylith-cli
-Version: 1.43.0
+Version: 1.44.0
 Summary: Python tooling support for the Polylith Architecture
 License: MIT
 Author: David Vujic

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/cli/core.py

@@ -27,11 +27,11 @@ def enriched_with_lock_files_data(root: Path, projects_data: List[dict], is_verb
     return [enriched_with_lock_file_data(root, p, is_verbose) for p in projects_data]
 
 @app.command('info')
-def info_command(short: Annotated[bool, options.short_workspace]=False, save: Annotated[bool, options.save]=False):
+def info_command(short: Annotated[bool, options.short_workspace]=False, save: Annotated[bool, options.save]=False, group: Annotated[str, options.group]=''):
     """Info about the Polylith workspace."""
     root = repo.get_workspace_root(Path.cwd())
     output = configuration.get_output_dir(root, 'info') if save else None
-    cli_options = {'short': short, 'save': save, 'output': output}
+    cli_options = {'short': short, 'save': save, 'output': output, 'groups': set(str.split(group, ',')) if group else set()}
     commands.info.run(root, cli_options)
 
 @app.command('check')

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/cli/options.py

@@ -20,3 +20,5 @@ quiet = Option(help="Do not output any messages.")
 brick = Option(help="Shows dependencies for selected brick.")
 save = Option(help="Store the contents of this command to file.")
 interface = Option(help="Show the brick interface.")
+
+group = Option(help="Show contents based on configured project group.")

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/commands/check.py

@@ -47,7 +47,7 @@ def run_each(root: Path, ns: str, project_data: dict, options: dict) -> Tuple[bo
     is_quiet = options['quiet']
     is_strict = options['strict']
     is_verbose = options['verbose']
-    name = project_data['name']
+    name = project_data.get('alias') or project_data['name']
     deps = project_data['deps']
     alias = options['alias']
     from_lock_file = libs.is_from_lock_file(deps)

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/commands/info.py

@@ -6,7 +6,9 @@ def run(root: Path, options: dict):
     bases = info.get_bases(root, ns)
     components = info.get_components(root, ns)
     projects_data = info.get_bricks_in_projects(root, components, bases, ns)
+    groups = options.get('groups')
+    filtered = [p for p in projects_data if p['groups'].intersection(groups)] if groups else projects_data
     info.print_workspace_summary(projects_data, bases, components, options)
     if not components and (not bases):
         return
-    info.print_bricks_in_projects(projects_data, bases, components, options)
+    info.print_bricks_in_projects(filtered or projects_data, bases, components, options)

polylith_cli-1.44.0/polylith_cli/polylith/configuration/__init__.py

@@ -0,0 +1,2 @@
+from polylith_cli.polylith.configuration.core import get_brick_structure_from_config, get_namespace_from_config, get_output_dir, get_project_alias_from_config, get_project_groups_from_config, get_resources_structure_from_config, get_tag_pattern_from_config, get_tag_sort_options_from_config, get_tests_structure_from_config, get_theme_from_config, is_readme_generation_enabled, is_test_generation_enabled
+__all__ = ['get_brick_structure_from_config', 'get_namespace_from_config', 'get_output_dir', 'get_project_alias_from_config', 'get_project_groups_from_config', 'get_resources_structure_from_config', 'get_tag_pattern_from_config', 'get_tag_sort_options_from_config', 'get_tests_structure_from_config', 'get_theme_from_config', 'is_readme_generation_enabled', 'is_test_generation_enabled']

polylith_cli-1.44.0/polylith_cli/polylith/configuration/core.py

@@ -0,0 +1,92 @@
+from pathlib import Path
+from typing import List, Set, Union
+from polylith_cli.polylith import repo
+
+def get_polylith_config(path: Path) -> dict:
+    toml: dict = repo.load_workspace_config(path)
+    conf = toml.get('tool', {}).get('polylith')
+    if not conf:
+        message = 'Cannot find a [tool.polylith] configuration.'
+        raise ValueError(message)
+    return conf
+
+def get_namespace_from_config(path: Path) -> str:
+    conf = get_polylith_config(path)
+    ns = conf.get('namespace')
+    if not ns:
+        message = 'Cannot find a [tool.polylith.namespace] section.'
+        raise ValueError(message)
+    return ns
+
+def get_tag_pattern_from_config(path: Path, key: Union[str, None]) -> Union[str, None]:
+    conf = get_polylith_config(path)
+    patterns = conf.get('tag', {}).get('patterns')
+    fallback = conf.get('git_tag_pattern')
+    if not key:
+        stable = patterns.get('stable') if patterns else None
+        return stable or fallback
+    return patterns.get(key) if patterns else None
+
+def get_tag_sort_options_from_config(path: Path) -> List[str]:
+    conf = get_polylith_config(path)
+    options = conf.get('tag', {}).get('sorting')
+    if options is None:
+        return ['-committerdate']
+    return options
+
+def is_test_generation_enabled(path: Path) -> bool:
+    conf = get_polylith_config(path)
+    enabled = conf.get('test', {}).get('enabled')
+    return bool(enabled)
+
+def is_readme_generation_enabled(path: Path) -> bool:
+    conf = get_polylith_config(path)
+    enabled = conf.get('resources', {}).get('brick_docs_enabled')
+    return bool(enabled)
+
+def get_theme_from_config(path: Path) -> str:
+    conf = get_polylith_config(path)
+    return conf.get('structure', {}).get('theme') or 'tdd'
+
+def get_brick_structure_from_config(path: Path) -> str:
+    theme = get_theme_from_config(path)
+    if theme == 'loose':
+        return '{brick}/{namespace}/{package}'
+    return '{brick}/{package}/src/{namespace}/{package}'
+
+def get_tests_structure_from_config(path: Path) -> str:
+    theme = get_theme_from_config(path)
+    if theme == 'loose':
+        return 'test/{brick}/{namespace}/{package}'
+    return '{brick}/{package}/test/{namespace}/{package}'
+
+def get_resources_structure_from_config(path: Path) -> str:
+    theme = get_theme_from_config(path)
+    if theme == 'loose':
+        return '{brick}/{namespace}/{package}'
+    return '{brick}/{package}'
+
+def get_output_dir(path: Path, command_name: str) -> str:
+    conf = get_polylith_config(path)
+    key = 'output'
+    commands = conf.get('commands') or {}
+    command = commands.get(command_name) or {}
+    output = command.get(key) or commands.get(key)
+    fallback = f'{repo.development_dir}/poly'
+    return output or fallback
+
+def get_projects_config(path: Path) -> dict:
+    conf = get_polylith_config(path)
+    return conf.get('projects', {})
+
+def get_project_alias_from_config(path: Path, project_name: str) -> Union[str, None]:
+    projects_conf = get_projects_config(path)
+    alias = projects_conf.get('alias', {})
+    return alias.get(project_name)
+
+def get_project_groups_from_config(path: Path, project_name: str) -> Set[str]:
+    projects_conf = get_projects_config(path)
+    groups = projects_conf.get('groups') or {}
+    if not groups:
+        return set()
+    return {k for k, v in groups.items() if project_name in v}

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/diff/report.py

@@ -9,7 +9,7 @@ def print_diff_details(projects_data: List[dict], bases: List[str], components:
         return
     console = Console(theme=theme.poly_theme)
     options = {'command': 'diff'}
-    table = info.report.build_bricks_in_projects_table(projects_data, bases, components, options)
+    table = info.build_bricks_in_projects_table(projects_data, bases, components, options)
     console.print(table, overflow='ellipsis')
 
 def print_detected_changes(changes: List[str], markup: str, short: bool) -> None:

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/imports/grouping.py

@@ -2,7 +2,7 @@ from typing import Set, Union
 
 
 def only_brick_imports(imports: Set[str], top_ns: str) -> Set[str]:
-    return {i for i in imports if i.startswith(top_ns)}
+    return {i for i in imports if i == top_ns or i.startswith(f"{top_ns}.")}
 
 
 def only_bricks(import_data: dict, top_ns: str) -> dict:
@@ -29,7 +29,7 @@ def exclude_empty(import_data: dict) -> dict:
     return {k: v for k, v in import_data.items() if v}
 
 
-def extract_brick_imports(all_imports: dict, top_ns) -> dict:
+def extract_brick_imports(all_imports: dict, top_ns: str) -> dict:
     with_only_bricks = only_bricks(all_imports, top_ns)
     with_only_brick_names = only_brick_names(with_only_bricks)
 

polylith_cli-1.44.0/polylith_cli/polylith/info/__init__.py

@@ -0,0 +1,3 @@
+from polylith_cli.polylith.info.collect import find_unused_bases, get_bases, get_bricks_in_projects, get_components, get_projects_data
+from polylith_cli.polylith.info.report import build_bricks_in_projects_table, is_project, print_bricks_in_projects, print_workspace_summary
+__all__ = ['find_unused_bases', 'get_bases', 'get_bricks_in_projects', 'get_components', 'get_projects_data', 'build_bricks_in_projects_table', 'is_project', 'print_bricks_in_projects', 'print_workspace_summary']

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/info/report.py

@@ -15,12 +15,13 @@ def is_project(project: dict) -> bool:
     return project['type'] == 'project'
 
 def printable_name(project: dict, short: bool) -> str:
+    alias = project.get('alias')
     if is_project(project):
         template = '[proj]{name}[/]'
-        name = project['name']
+        name = alias or project['name']
     else:
         template = '[data]{name}[/]'
-        name = 'development'
+        name = alias or 'development'
     if short:
         return template.format(name='\n'.join(name))
     return template.format(name=name)
@@ -53,6 +54,7 @@ def print_bricks_in_projects(projects_data: List[dict], bases: List[str], compon
 
 def print_workspace_summary(projects_data: List[dict], bases: List[str], components: List[str], options: dict) -> None:
     save = options.get('save', False)
+    groups = ', '.join(options.get('groups') or set())
     console = Console(theme=theme.poly_theme, record=save)
     console.print(Padding('[data]Workspace summary[/]', (1, 0, 1, 0)))
     number_of_projects = len([p for p in projects_data if is_project(p)])
@@ -63,5 +65,7 @@ def print_workspace_summary(projects_data: List[dict], bases: List[str], compone
     console.print(f'[comp]components[/]: [data]{number_of_components}[/]')
     console.print(f'[base]bases[/]: [data]{number_of_bases}[/]')
     console.print(f'[data]development[/]: [data]{number_of_dev}[/]')
+    if groups:
+        console.print(Padding(f'[data]group[/]: [proj]{groups}[/]', (1, 0, 0, 0)))
     if save:
         output.save_recorded(console, options, 'workspace_summary')

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/libs/report.py

@@ -83,13 +83,16 @@ def printable_version(version: Union[str, None], is_same_version: bool) -> str:
 def get_version(lib: str, project_data: dict) -> str:
     return project_data['deps']['items'].get(lib)
 
-def find_version(lib: str, project_name: str, projects_data: List[dict]) -> Union[str, None]:
-    project_data = next((p for p in projects_data if p['name'] == project_name))
+def find_version(lib: str, project_data: dict) -> Union[str, None]:
     return get_version(lib, project_data)
 
 def printable_header(header: str, short: bool) -> str:
     return '\n'.join(header) if short else header
 
+def printable_project_header(project_data: dict, short: bool) -> str:
+    name = project_data.get('alias') or project_data['name']
+    return printable_header(name, short)
+
 def is_same_version(versions: list) -> bool:
     unique = {v for v in versions if v}
     return len(unique) == 1 if unique else True
@@ -97,14 +100,14 @@ def is_same_version(versions: list) -> bool:
 def libs_in_projects_table(development_data: dict, projects_data: List[dict], libraries: set, options: dict) -> Table:
     table = Table(box=box.SIMPLE_HEAD)
     short = options['short']
-    project_names = sorted({p['name'] for p in projects_data})
-    project_headers = [f'[proj]{printable_header(n, short)}[/]' for n in project_names]
+    projects = sorted(projects_data, key=lambda p: p['name'])
+    proj_headers = [f'[proj]{printable_project_header(p, short)}[/]' for p in projects]
     dev_header = printable_header('development', short)
-    headers = ['[data]library[/]'] + project_headers + [f'[data]{dev_header}[/]']
+    headers = ['[data]library[/]'] + proj_headers + [f'[data]{dev_header}[/]']
     for header in headers:
         table.add_column(header)
     for lib in sorted(libraries):
-        proj_versions = [find_version(lib, n, projects_data) for n in project_names]
+        proj_versions = [find_version(lib, p) for p in projects]
         dev_version = get_version(lib, development_data)
         is_same = is_same_version(proj_versions + [dev_version])
         printable_proj_versions = [printable_version(v, is_same) for v in proj_versions]

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/project/get.py

@@ -1,6 +1,6 @@
 from functools import lru_cache
 from pathlib import Path
-from typing import List
+from typing import List, Set, Union
 import tomlkit
 from polylith_cli.polylith import configuration, repo, toml
 from polylith_cli.polylith.project import templates
@@ -17,6 +17,14 @@ def get_project_name_from_toml(data: dict) -> str:
         path = data['path']
         raise KeyError(f'Error in {path}') from e
 
+def get_project_alias(path: Path, data: dict) -> Union[str, None]:
+    project_name = get_project_name_from_toml(data)
+    return configuration.get_project_alias_from_config(path, project_name)
+
+def get_project_groups(path: Path, data: dict) -> Set[str]:
+    project_name = get_project_name_from_toml(data)
+    return configuration.get_project_groups_from_config(path, project_name)
+
 @lru_cache
 def get_toml(path: Path) -> tomlkit.TOMLDocument:
     return toml.read_toml_document(path)
@@ -40,7 +48,7 @@ def get_toml_files(root: Path) -> List[dict]:
 def get_packages_for_projects(root: Path) -> List[dict]:
     toml_files = get_toml_files(root)
     namespace = configuration.get_namespace_from_config(root)
-    return [{'name': get_project_name_from_toml(d), 'packages': toml.get_project_package_includes(namespace, d['toml']), 'path': d['path'], 'type': d['type'], 'deps': toml.get_project_dependencies(d['toml']), 'exclude': toml.collect_configured_exclude_patterns(d['toml'])} for d in toml_files]
+    return [{'name': get_project_name_from_toml(d), 'alias': get_project_alias(root, d), 'groups': get_project_groups(root, d), 'packages': toml.get_project_package_includes(namespace, d['toml']), 'path': d['path'], 'type': d['type'], 'deps': toml.get_project_dependencies(d['toml']), 'exclude': toml.collect_configured_exclude_patterns(d['toml'])} for d in toml_files]
 
 def _get_poetry_template(pyproject: dict) -> str:
     if repo.is_pep_621_ready(pyproject):

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/sync/collect.py

@@ -29,7 +29,7 @@ def _calculate(root: Path, namespace: str, project_data: dict, bases: Set[str])
     bases_diff = {b for b in brick_diff if b in all_bases}
     comp_diff = {b for b in brick_diff if b in all_components}
     fn = partial(_without_empty, root, namespace)
-    return {'name': project_data['name'], 'path': project_data['path'], 'is_project': is_project, 'bases': bases_diff if is_project else fn(bases_diff, 'bases'), 'components': comp_diff if is_project else fn(comp_diff, 'components'), 'brick_imports': brick_imports}
+    return {'name': project_data['name'], 'alias': project_data['alias'], 'path': project_data['path'], 'is_project': is_project, 'bases': bases_diff if is_project else fn(bases_diff, 'bases'), 'components': comp_diff if is_project else fn(comp_diff, 'components'), 'brick_imports': brick_imports}
 
 def calculate_diff(root: Path, namespace: str, project_data: dict) -> dict:
     bases = set(project_data['bases'])

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/polylith_cli/polylith/sync/report.py

@@ -9,7 +9,7 @@ def print_brick_imports(diff: dict) -> None:
 def print_summary(diff: dict) -> None:
     console = Console(theme=theme.poly_theme)
     is_project = diff['is_project']
-    name = diff['name'] if is_project else 'development'
+    name = diff['alias'] or diff['name'] if is_project else 'development'
     bases = diff['bases']
     components = diff['components']
     anything_to_sync = bases or components

{polylith_cli-1.43.0 → polylith_cli-1.44.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "polylith-cli"
-version = "1.43.0"
+version = "1.44.0"
 description = "Python tooling support for the Polylith Architecture"
 authors = ['David Vujic']
 homepage = "https://davidvujic.github.io/python-polylith-docs/"

polylith_cli-1.43.0/polylith_cli/polylith/configuration/__init__.py

@@ -1,2 +0,0 @@
-from polylith_cli.polylith.configuration.core import get_brick_structure_from_config, get_namespace_from_config, get_output_dir, get_resources_structure_from_config, get_tag_pattern_from_config, get_tag_sort_options_from_config, get_tests_structure_from_config, get_theme_from_config, is_readme_generation_enabled, is_test_generation_enabled
-__all__ = ['get_brick_structure_from_config', 'get_namespace_from_config', 'get_output_dir', 'get_resources_structure_from_config', 'get_tag_pattern_from_config', 'get_tag_sort_options_from_config', 'get_tests_structure_from_config', 'get_theme_from_config', 'is_readme_generation_enabled', 'is_test_generation_enabled']

polylith_cli-1.43.0/polylith_cli/polylith/configuration/core.py

@@ -1,67 +0,0 @@
-from pathlib import Path
-from typing import List, Union
-from polylith_cli.polylith import repo
-
-def get_namespace_from_config(path: Path) -> str:
-    toml: dict = repo.load_workspace_config(path)
-    return toml['tool']['polylith']['namespace']
-
-def get_git_tag_pattern(toml: dict) -> str:
-    """Fallback git tag pattern configuration"""
-    return toml['tool']['polylith']['git_tag_pattern']
-
-def get_tag_pattern_from_config(path: Path, key: Union[str, None]) -> Union[str, None]:
-    toml: dict = repo.load_workspace_config(path)
-    patterns = toml['tool']['polylith'].get('tag', {}).get('patterns')
-    if not key:
-        return patterns['stable'] if patterns else get_git_tag_pattern(toml)
-    return patterns.get(key)
-
-def get_tag_sort_options_from_config(path: Path) -> List[str]:
-    toml: dict = repo.load_workspace_config(path)
-    options = toml['tool']['polylith'].get('tag', {}).get('sorting')
-    if options is None:
-        return ['-committerdate']
-    return options
-
-def is_test_generation_enabled(path: Path) -> bool:
-    toml: dict = repo.load_workspace_config(path)
-    enabled = toml['tool']['polylith']['test']['enabled']
-    return bool(enabled)
-
-def is_readme_generation_enabled(path: Path) -> bool:
-    toml: dict = repo.load_workspace_config(path)
-    enabled = toml['tool']['polylith'].get('resources', {}).get('brick_docs_enabled')
-    return bool(enabled)
-
-def get_theme_from_config(path: Path) -> str:
-    toml: dict = repo.load_workspace_config(path)
-    return toml['tool']['polylith']['structure'].get('theme') or 'tdd'
-
-def get_brick_structure_from_config(path: Path) -> str:
-    theme = get_theme_from_config(path)
-    if theme == 'loose':
-        return '{brick}/{namespace}/{package}'
-    return '{brick}/{package}/src/{namespace}/{package}'
-
-def get_tests_structure_from_config(path: Path) -> str:
-    theme = get_theme_from_config(path)
-    if theme == 'loose':
-        return 'test/{brick}/{namespace}/{package}'
-    return '{brick}/{package}/test/{namespace}/{package}'
-
-def get_resources_structure_from_config(path: Path) -> str:
-    theme = get_theme_from_config(path)
-    if theme == 'loose':
-        return '{brick}/{namespace}/{package}'
-    return '{brick}/{package}'
-
-def get_output_dir(path: Path, command_name: str) -> str:
-    toml: dict = repo.load_workspace_config(path)
-    key = 'output'
-    tool = toml['tool']['polylith']
-    commands = tool.get('commands', {})
-    command = commands.get(command_name, {})
-    output = command.get(key) or commands.get(key)
-    fallback = f'{repo.development_dir}/poly'
-    return output or fallback

polylith_cli-1.43.0/polylith_cli/polylith/info/__init__.py

@@ -1,3 +0,0 @@
-from polylith_cli.polylith.info.collect import find_unused_bases, get_bases, get_bricks_in_projects, get_components, get_projects_data
-from polylith_cli.polylith.info.report import is_project, print_bricks_in_projects, print_workspace_summary
-__all__ = ['find_unused_bases', 'get_bases', 'get_bricks_in_projects', 'get_components', 'get_projects_data', 'is_project', 'print_bricks_in_projects', 'print_workspace_summary']