fix(python)!: Poetry python project is using deprecated `dev-dependen…

…cies` notation in `pyproject.toml` (#3375)

[Poetry 1.2.0](https://python-poetry.org/blog/announcing-poetry-1.2.0/) introduced the `group` notation for managing dependencies, which has been the recommended way to organize dependencies inside your `pyproject.toml` file for almost two years. The older `dev-dependencies` notation was deprecated, as detailed [here](https://python-poetry.org/docs/master/managing-dependencies/), and its use is discouraged.

BREAKING CHANGE: Poetry is now required to be at version 1.2.0 or above. Please update Poetry if needed.

---
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

src/python/poetry.ts

@@ -373,23 +373,30 @@ export class PoetryPyproject extends Component {
   constructor(project: Project, options: PoetryPyprojectOptions) {
     super(project);
 
-    const decamelisedOptions = decamelizeKeysRecursively(options, {
-      separator: "-",
-    });
-
-    this.file = new TomlFile(project, "pyproject.toml", {
-      omitEmpty: false,
-      obj: {
-        "build-system": {
-          requires: ["poetry_core>=1.0.0"],
-          "build-backend": "poetry.core.masonry.api",
-        },
-        tool: {
-          poetry: {
-            ...decamelisedOptions,
+    const { dependencies, devDependencies, ...otherOptions } = options;
+    const decamelizedOptions = decamelizeKeysRecursively(otherOptions);
+
+    const tomlStructure: any = {
+      tool: {
+        poetry: {
+          ...decamelizedOptions,
+          dependencies: dependencies,
+          group: {
+            dev: {
+              dependencies: devDependencies,
+            },
           },
         },
       },
+      "build-system": {
+        requires: ["poetry-core"],
+        "build-backend": "poetry.core.masonry.api",
+      },
+    };
+
+    this.file = new TomlFile(project, "pyproject.toml", {
+      omitEmpty: false,
+      obj: tomlStructure,
     });
   }
 }

test/python/poetry.test.ts

@@ -1,3 +1,4 @@
+import * as TOML from "@iarna/toml";
 import { python } from "../../src";
 import * as logging from "../../src/logging";
 import { synthSnapshot } from "../util";
@@ -218,3 +219,53 @@ class TestPythonProject extends python.PythonProject {
     });
   }
 }
+
+test("generates correct pyproject.toml content", () => {
+  const project = new TestPythonProject({
+    poetry: true,
+    homepage: "http://www.example.com",
+    description: "A short project description",
+    license: "Apache-2.0",
+    deps: ["aws-cdk-lib@^2.128.0"],
+    devDeps: ["black@^24.2.0", "flake8@^7.0.0"],
+  });
+
+  const snapshot = synthSnapshot(project);
+  const actualTomlContent = snapshot["pyproject.toml"];
+
+  const actualContentObject = TOML.parse(actualTomlContent);
+
+  const expectedContentObject = {
+    tool: {
+      poetry: {
+        name: "test-python-project",
+        version: "0.1.0",
+        description: "A short project description",
+        license: "Apache-2.0",
+        authors: ["First Last <email@example.com>"],
+        homepage: "http://www.example.com",
+        readme: "README.md",
+        dependencies: {
+          "aws-cdk-lib": "^2.128.0",
+          python: "^3.8",
+        },
+        group: {
+          dev: {
+            dependencies: {
+              black: "^24.2.0",
+              flake8: "^7.0.0",
+              projen: "99.99.99",
+              pytest: "7.4.3",
+            },
+          },
+        },
+      },
+    },
+    "build-system": {
+      requires: ["poetry-core"],
+      "build-backend": "poetry.core.masonry.api",
+    },
+  };
+
+  expect(actualContentObject).toEqual(expectedContentObject);
+});