feat: Allow defining direct path to pyproject.toml #525

n8felton · 2024-01-04T20:47:03Z

Description

This change allows you to define the location of a pyproject.toml file, rather than relying on the discovery of the file in a given directory.

Example 1

  source_path = [
    "src",
    "pyproject.toml"
  ]

Example 2

  source_path = [
    "src",
    {
      path = "pyproject.toml",
      poetry_install = true
    }
  ]

Motivation and Context

Previously, discovery and execution of poetry related commands required discovery of the pyproject.toml, poetry.lock, and poetry.toml in a given directory, which required the entire directory to be included in the resulting Zip file, which is not always desired. This PR allows you to define the direct path to the pyproject.toml without needing to rely on it being discovered.

Addition context in #524

Breaking Changes

In my testing, this does not cause any breaking changes with existing poetry deployments.

How Has This Been Tested?

I have updated at least one of the examples/* to demonstrate and validate my change(s)
I have tested and validated these changes using one or more of the provided examples/* projects

I have also validated these changes against the existing package_dir_poetry module.

I have executed pre-commit run -a on my pull request

Fixes #524

mar-pan · 2024-01-08T14:02:18Z

Hello module devs. Can we have this reviewed and merged? I'm facing issue which this one will solve

antonbabenko · 2024-01-12T10:28:21Z

@pdecat Could you please take a look at this one?

pdecat · 2024-01-12T13:50:42Z

Hi, I left some comments in the issue. Right now, I believe changes should not be needed to make this work.

pdecat

I guess I understand the changes, looks good overall. Left a few comments, PTAL.

I'll test this ASAP.

package.py

pdecat · 2024-01-12T15:01:28Z

package.py

            poetry_lock_target_file = copy_file_to_target(poetry_lock_file, temp_dir)
        else:
            poetry_lock_target_file = None

        if os.path.isfile(poetry_toml_file):
-            log.info("Using poetry configuration file: %s", poetry_lock_file)
+            log.info("Using poetry.toml configuration file: %s", poetry_toml_file)


This kind of duplicates the poetry.toml in the output, doesn't it?

Suggested change

log.info("Using poetry.toml configuration file: %s", poetry_toml_file)

log.info("Using poetry toml configuration file: %s", poetry_toml_file)

This was to be consistent with the poetry.lock file output above, so if neither are desired, it can be removed.

The larger change and bug fix was having the output point to poetry_toml_file instead of poetry_lock_file

The larger change and bug fix was having the output point to poetry_toml_file instead of poetry_lock_file

Yeah, noticed that part 👍

package.py

Co-authored-by: Patrick Decat <[email protected]>

pdecat

While trying the new examples, it failed because python3.9-app-src-poetry does not exist.

Did you mean python3.9-app-poetry, or did you forget to add that directory?

Edit: I guess it is the latter, and it should contain an src/ sub-directory.

examples/build-package/main.tf

pdecat

Please add the missing python3.9-app-src-poetry test fixture, and use different values for artifacts_dir.

examples/build-package/main.tf

pdecat

A few issues with the examples remain.

pdecat

Finally tested this against some existing stacks, does not break anything.

LGTM

n8felton · 2024-01-16T20:21:49Z

🎉

Thank you for working through this PR with me, I appreciate the timely back and forth to get things answered and resolved. 🙇

@antonbabenko - I believe this is ready for your review.

antonbabenko

LGTM

## [6.8.0](v6.7.1...v6.8.0) (2024-01-17) ### Features * Allow defining direct path to pyproject.toml ([#525](#525)) ([d33b722](d33b722))

antonbabenko · 2024-01-17T09:06:14Z

This PR is included in version 6.8.0 🎉

antonbabenko · 2024-01-17T09:06:19Z

Awesome! Thanks to both of you for the cooperation & review!

github-actions · 2024-02-17T02:01:47Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

n8felton added 3 commits January 4, 2024 14:53

Allow defining direct path to pyproject.toml

bf4765f

Add examples of poetry with src dir

a75d4af

Fix logging around which files are used

adfbe11

n8felton changed the title ~~Allow defining direct path to pyproject.toml~~ fix: Allow defining direct path to pyproject.toml Jan 4, 2024

pdecat mentioned this pull request Jan 12, 2024

How to use Poetry with src directory but with poetry.lock and pyproject.toml at root. #524

Closed

1 task

pdecat reviewed Jan 12, 2024

View reviewed changes

Apply suggestions from code review

ef45c16

Co-authored-by: Patrick Decat <[email protected]>

pdecat suggested changes Jan 16, 2024

View reviewed changes

examples/build-package/main.tf Show resolved Hide resolved

examples/build-package/main.tf Show resolved Hide resolved

examples/build-package/main.tf Show resolved Hide resolved

examples/build-package/main.tf Show resolved Hide resolved

examples/build-package/main.tf Show resolved Hide resolved

pdecat suggested changes Jan 16, 2024

View reviewed changes

examples/build-package/main.tf Outdated Show resolved Hide resolved

examples/build-package/main.tf Outdated Show resolved Hide resolved

n8felton added 3 commits January 16, 2024 12:10

Move to src artifacts_dir

ef44157

Add python3.9-app-src-poetry fixture

e794079

Merge branch 'master' into poetry_path

062bbf5

pdecat reviewed Jan 16, 2024

View reviewed changes

examples/build-package/main.tf Show resolved Hide resolved

pdecat reviewed Jan 16, 2024

View reviewed changes

examples/build-package/main.tf Outdated Show resolved Hide resolved

pdecat reviewed Jan 16, 2024

View reviewed changes

examples/build-package/main.tf Show resolved Hide resolved

pdecat suggested changes Jan 16, 2024

View reviewed changes

Match path to module name

853504c

pdecat approved these changes Jan 16, 2024

View reviewed changes

antonbabenko changed the title ~~fix: Allow defining direct path to pyproject.toml~~ feat: Allow defining direct path to pyproject.toml Jan 17, 2024

antonbabenko approved these changes Jan 17, 2024

View reviewed changes

antonbabenko merged commit d33b722 into terraform-aws-modules:master Jan 17, 2024
30 checks passed

antonbabenko pushed a commit that referenced this pull request Jan 17, 2024

chore(release): version 6.8.0 [skip ci]

20f6aae

## [6.8.0](v6.7.1...v6.8.0) (2024-01-17) ### Features * Allow defining direct path to pyproject.toml ([#525](#525)) ([d33b722](d33b722))

n8felton deleted the poetry_path branch January 17, 2024 14:59

github-actions bot locked as resolved and limited conversation to collaborators Feb 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Allow defining direct path to pyproject.toml #525

feat: Allow defining direct path to pyproject.toml #525

n8felton commented Jan 4, 2024 •

edited

Loading

mar-pan commented Jan 8, 2024

antonbabenko commented Jan 12, 2024

pdecat commented Jan 12, 2024

pdecat left a comment

pdecat Jan 12, 2024

n8felton Jan 12, 2024

n8felton Jan 12, 2024

pdecat Jan 12, 2024

pdecat left a comment •

edited

Loading

pdecat left a comment

pdecat left a comment

pdecat left a comment

n8felton commented Jan 16, 2024 •

edited

Loading

antonbabenko left a comment

antonbabenko commented Jan 17, 2024

antonbabenko commented Jan 17, 2024

github-actions bot commented Feb 17, 2024

	log.info("Using poetry.toml configuration file: %s", poetry_toml_file)
	log.info("Using poetry toml configuration file: %s", poetry_toml_file)

feat: Allow defining direct path to pyproject.toml #525

feat: Allow defining direct path to pyproject.toml #525

Conversation

n8felton commented Jan 4, 2024 • edited Loading

Description

Example 1

Example 2

Motivation and Context

Breaking Changes

How Has This Been Tested?

mar-pan commented Jan 8, 2024

antonbabenko commented Jan 12, 2024

pdecat commented Jan 12, 2024

pdecat left a comment

Choose a reason for hiding this comment

pdecat Jan 12, 2024

Choose a reason for hiding this comment

n8felton Jan 12, 2024

Choose a reason for hiding this comment

n8felton Jan 12, 2024

Choose a reason for hiding this comment

pdecat Jan 12, 2024

Choose a reason for hiding this comment

pdecat left a comment • edited Loading

Choose a reason for hiding this comment

pdecat left a comment

Choose a reason for hiding this comment

pdecat left a comment

Choose a reason for hiding this comment

pdecat left a comment

Choose a reason for hiding this comment

n8felton commented Jan 16, 2024 • edited Loading

antonbabenko left a comment

Choose a reason for hiding this comment

antonbabenko commented Jan 17, 2024

antonbabenko commented Jan 17, 2024

github-actions bot commented Feb 17, 2024

n8felton commented Jan 4, 2024 •

edited

Loading

pdecat left a comment •

edited

Loading

n8felton commented Jan 16, 2024 •

edited

Loading