New Python functions `lf.package_directory()` and `lf.source_directory()` #455

edwardalee · 2024-06-25T18:11:26Z

This PR adds to Python a mechanism to obtain the path of the source directory (the main .lf file) and the package root (where src and bin are). This mirrors the constants available in the C target LF_SOURCE_DIRECTORY and LF_PACKAGE_DIRECTORY.

This PR is joint with @vinzbarbuto.

Summary by CodeRabbit

New Features
- Introduced new functions for handling directory paths: py_source_directory and py_package_directory.
Enhancements
- Improved module functionality related to directory handling with new path-returning features.

coderabbitai · 2024-06-25T18:11:34Z

Walkthrough

The recent updates introduce two new functions, py_source_directory and py_package_directory, in the python/include/pythontarget.h and python/lib/pythontarget.c files. These functions are designed to return directory paths as Python strings, enhancing the module's capabilities in handling directory paths.

Changes

Files	Change Summary
python/include/pythontarget.h	Added declarations for `py_source_directory` and `py_package_directory`.
python/lib/pythontarget.c	Implemented `py_source_directory` and `py_package_directory` to return decoded paths.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PythonModule
    User->>PythonModule: Call py_source_directory()
    PythonModule-->>User: Return source directory path as string
    
    User->>PythonModule: Call py_package_directory()
    PythonModule-->>User: Return package directory path as string

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

coderabbitai

Actionable comments posted: 3

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between eb48bae and 761dd04.

Files selected for processing (2)

python/include/pythontarget.h (1 hunks)
python/lib/pythontarget.c (2 hunks)

Files skipped from review due to trivial changes (1)

python/include/pythontarget.h

python/lib/pythontarget.c

cmnrd

As I pointed out for the corresponding C constants, I think it is a bad practice to expose information about the location of compiled files as static constants to the program. This means that a compiled program cannot be redeployed to a different location.

What is this needed for?

edwardalee · 2024-06-28T12:20:19Z

This is needed so that a reactor can access a data file. The motivating application is an ML model. Do you have an alternative suggestion?

cmnrd · 2024-06-28T13:37:10Z

Why not provide the path via runtime parameters? This could be done via CLI arguments (I guess this is not supported for the python and C targets) or by reading an environment variable.

lhstrh · 2024-06-30T21:29:45Z

@cmnrd:I think the conclusion we reached during our last call was that we can admit this as a temporary solution?

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 761dd04 and ae9e5f4.

Files selected for processing (1)

python/lib/pythontarget.c (2 hunks)

Files skipped from review as they are similar to previous changes (1)

python/lib/pythontarget.c

cmnrd

Looks good!

Added Python functions lf.package_directory() and lf.source_director()

761dd04

edwardalee added enhancement Enhancement of existing feature python labels Jun 25, 2024

edwardalee mentioned this pull request Jun 25, 2024

API to look up source and package directory in Python lf-lang/lingua-franca#2331

Merged

coderabbitai bot reviewed Jun 25, 2024

View reviewed changes

python/lib/pythontarget.c Outdated Show resolved Hide resolved

python/lib/pythontarget.c Outdated Show resolved Hide resolved

python/lib/pythontarget.c Outdated Show resolved Hide resolved

edwardalee mentioned this pull request Jun 25, 2024

Document Python path functions lf-lang/lf-lang.github.io#269

Merged

Format

193b629

lhstrh requested a review from cmnrd June 25, 2024 20:29

cmnrd reviewed Jun 28, 2024

View reviewed changes

Test for undefined constants

ae9e5f4

coderabbitai bot reviewed Jul 2, 2024

View reviewed changes

Merge branch 'main' into python-paths

450d11e

edwardalee requested review from cmnrd and lhstrh July 2, 2024 17:48

lhstrh added feature New feature and removed enhancement Enhancement of existing feature labels Jul 4, 2024

lhstrh changed the title ~~Added Python functions lf.package_directory() and lf.source_director()~~ New Python functions lf.package_directory() and lf.source_director() Jul 4, 2024

lhstrh changed the title ~~New Python functions lf.package_directory() and lf.source_director()~~ New Python functions lf.package_directory() and lf.source_directory() Jul 4, 2024

cmnrd approved these changes Jul 4, 2024

View reviewed changes

lhstrh added this pull request to the merge queue Jul 4, 2024

Merged via the queue into main with commit 8fe0436 Jul 4, 2024
29 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New Python functions `lf.package_directory()` and `lf.source_directory()` #455

New Python functions `lf.package_directory()` and `lf.source_directory()` #455

edwardalee commented Jun 25, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 25, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

cmnrd left a comment •

edited

Loading

edwardalee commented Jun 28, 2024

cmnrd commented Jun 28, 2024

lhstrh commented Jun 30, 2024

coderabbitai bot left a comment

cmnrd left a comment

New Python functions lf.package_directory() and lf.source_directory() #455

New Python functions lf.package_directory() and lf.source_directory() #455

Conversation

edwardalee commented Jun 25, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Jun 25, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

cmnrd left a comment • edited Loading

Choose a reason for hiding this comment

edwardalee commented Jun 28, 2024

cmnrd commented Jun 28, 2024

lhstrh commented Jun 30, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

cmnrd left a comment

Choose a reason for hiding this comment

New Python functions `lf.package_directory()` and `lf.source_directory()` #455

New Python functions `lf.package_directory()` and `lf.source_directory()` #455

edwardalee commented Jun 25, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jun 25, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

cmnrd left a comment •

edited

Loading