Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: Only install python files for enabled components #4004

Merged

Conversation

paulgessinger
Copy link
Member

@paulgessinger paulgessinger commented Jan 6, 2025

--- END COMMIT MESSAGE ---

Any further description goes here, @-mentions are ok here!

  • Use a conventional commits prefix: quick summary
    • We mostly use feat, fix, refactor, docs, chore and build types.
  • A milestone will be assigned by one of the maintainers

Summary by CodeRabbit

  • Chores
    • Updated CMake configuration for Python file installation
    • Improved file installation process to preserve directory structure
    • Removed symbolic link creation for Python files

@paulgessinger paulgessinger added this to the next milestone Jan 6, 2025
Copy link

coderabbitai bot commented Jan 6, 2025

Walkthrough

Hmm, changes to CMakeLists.txt, I see. A transformation of Python file installation method, this is. Gone are the symbolic links, replaced by direct file installation with preserved directory structure. The CMake configuration now ensures files land in their rightful subdirectories, maintaining the path integrity they once knew.

Changes

File Change Summary
Examples/Python/CMakeLists.txt Replaced symbolic link creation with direct file installation, preserving original directory hierarchy

Poem

In paths of code, wisdom flows
🐍 Python files, no longer in rows
Directories dance, structure preserved
CMake's magic, carefully observed
Links symbolic, now fade away 🌟
Paths true and clear, code's new way

Chuckles softly in Yoda-speak


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ff60049 and 0c6de55.

📒 Files selected for processing (1)
  • Examples/Python/CMakeLists.txt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: merge-sentinel
  • GitHub Check: unused_files
  • GitHub Check: macos
  • GitHub Check: missing_includes
  • GitHub Check: CI Bridge / lcg_106a: [alma9, clang16]
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc14]
  • GitHub Check: linux_ubuntu_extra (ubuntu2204_clang, 20)
  • GitHub Check: CI Bridge / lcg_106a: [alma9, gcc13]
  • GitHub Check: CI Bridge / lcg_105: [alma9, gcc13]
  • GitHub Check: CI Bridge / lcg_105: [alma9, clang16]
  • GitHub Check: CI Bridge / linux_ubuntu_2204
  • GitHub Check: CI Bridge / linux_ubuntu_2204_clang
  • GitHub Check: linux_ubuntu_extra (ubuntu2204, 20)
  • GitHub Check: CI Bridge / build_linux_ubuntu
  • GitHub Check: CI Bridge / build_exatrkx
  • GitHub Check: CI Bridge / build_exatrkx_cpu
  • GitHub Check: CI Bridge / clang_tidy
  • GitHub Check: linux_ubuntu
  • GitHub Check: build_debug
🔇 Additional comments (2)
Examples/Python/CMakeLists.txt (2)

272-277: Hmmmm, wise changes these are, approve them I do!

A more elegant solution this is, young padawan. Direct file installation with preserved directory structure, better than symbolic links it is. The Force flows stronger through this implementation, yes.

Verify the path handling we must. Run this command, we shall:

✅ Verification successful

Safe and sound, the path structure is! Hmmmm.

Through the Force, I sense no disturbance in the Python paths. One relative import only, in __init__.py it lives, and preserved perfectly the directory structure shall be. Strong with the CMake, this solution is!

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any potential path issues in Python files

# Search for relative imports that might break with the new structure
rg -g '*.py' -A 3 'from \.\.' python/acts/

Length of output: 97


Script:

#!/bin/bash
# First, find all Python files
echo "=== Python Files Structure ==="
fd -e py . Examples/Python

# Then examine their imports
echo -e "\n=== Import Statements ==="
fd -e py . Examples/Python --exec rg -l "from \.\.|from \."

# Check the directory structure
echo -e "\n=== Directory Structure ==="
fd . Examples/Python/python/acts -t d

Length of output: 2037


274-277: Mindful of plugins, we must be!

A path to wisdom this change is, but careful with plugin files we must remain. Each plugin's Python files, installed correctly they must be.

Check plugin paths we shall:

✅ Verification successful

Correct and wise, the path structure is!

Through the Force, I see the Python files organized well they are. Under Examples/Python/python/acts/examples/, all plugin files reside, and the installation path ${_python_install_dir}/${_rel} preserves this structure it does. No conflicts in the paths, there are.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify plugin Python files installation paths

# List all Python files from plugins
echo "=== Plugin Python files ==="
fd -e py . python/acts/examples/

# Check for potential path conflicts
echo "=== Checking for path conflicts ==="
fd -e py . python/acts/ -x dirname {} | sort | uniq -d

Length of output: 448


Script:

#!/bin/bash
# First, find all Python files to understand the structure
echo "=== All Python files ==="
fd -e py

# Then look for CMake files that might handle plugins
echo -e "\n=== CMake files mentioning Python plugins ==="
rg -l "python" --type cmake

# Finally, check the actual plugin structure
echo -e "\n=== Plugin-related directories ==="
fd "plugin|examples" -t d

Length of output: 9741


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the Component - Examples Affects the Examples module label Jan 6, 2025
Copy link

github-actions bot commented Jan 6, 2025

📊: Physics performance monitoring for 6f5800d

Full contents

physmon summary

Copy link
Contributor

@goetzgaycken goetzgaycken left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good and solves the issue that python bindings for geant4 examples used to be installed also if geant4 support was disabled.

@kodiakhq kodiakhq bot merged commit ba5a781 into acts-project:main Jan 15, 2025
42 checks passed
@acts-project-service acts-project-service added the Fails Athena tests This PR causes a failure in the Athena tests label Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Examples Affects the Examples module Fails Athena tests This PR causes a failure in the Athena tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants