feat(onboarding): add poetry as an option to python install snippets (#90365)

shellmayr · web-flow · commit 47fec42ddf49 · 2025-05-07T11:33:55.000+02:00
diff --git a/static/app/gettingStartedDocs/python/bottle.tsx b/static/app/gettingStartedDocs/python/bottle.tsx
@@ -72,7 +72,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[bottle]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[bottle]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/celery.tsx b/static/app/gettingStartedDocs/python/celery.tsx
@@ -72,7 +72,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[celery]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[celery]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/chalice.tsx b/static/app/gettingStartedDocs/python/chalice.tsx
@@ -77,7 +77,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[chalice]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[chalice]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/django.tsx b/static/app/gettingStartedDocs/python/django.tsx
@@ -68,7 +68,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[django]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[django]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/falcon.tsx b/static/app/gettingStartedDocs/python/falcon.tsx
@@ -73,7 +73,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[falcon]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[falcon]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/fastapi.tsx b/static/app/gettingStartedDocs/python/fastapi.tsx
@@ -75,7 +75,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[fastapi]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[fastapi]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/flask.tsx b/static/app/gettingStartedDocs/python/flask.tsx
@@ -74,7 +74,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[flask]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[flask]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/mongo.tsx b/static/app/gettingStartedDocs/python/mongo.tsx
@@ -47,7 +47,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[pymongo]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[pymongo]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/quart.tsx b/static/app/gettingStartedDocs/python/quart.tsx
@@ -75,7 +75,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[quart]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[quart]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/rq.tsx b/static/app/gettingStartedDocs/python/rq.tsx
@@ -101,7 +101,7 @@ const onboarding: OnboardingConfig = {
       description: tct('Install [code:sentry-sdk] from PyPI with the [code:rq] extra:', {
         code: <code />,
       }),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[rq]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[rq]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/gettingStartedDocs/python/sanic.tsx b/static/app/gettingStartedDocs/python/sanic.tsx
@@ -48,7 +48,7 @@ const onboarding: OnboardingConfig = {
         }
       ),
       configurations: [
-        ...getPythonInstallConfig({packageName: "'sentry-sdk[sanic]'"}),
+        ...getPythonInstallConfig({packageName: 'sentry-sdk[sanic]'}),
         ...getPythonAiocontextvarsConfig(),
       ],
     },
diff --git a/static/app/gettingStartedDocs/python/starlette.tsx b/static/app/gettingStartedDocs/python/starlette.tsx
@@ -73,7 +73,7 @@ const onboarding: OnboardingConfig = {
           code: <code />,
         }
       ),
-      configurations: getPythonInstallConfig({packageName: "'sentry-sdk[starlette]'"}),
+      configurations: getPythonInstallConfig({packageName: 'sentry-sdk[starlette]'}),
     },
   ],
   configure: (params: Params) => [
diff --git a/static/app/utils/gettingStartedDocs/python.spec.tsx b/static/app/utils/gettingStartedDocs/python.spec.tsx
@@ -0,0 +1,33 @@
+// Mock the modules that cause circular dependencies
+jest.mock('sentry/utils/gettingStartedDocs/python', () => {
+  const original = jest.requireActual('sentry/utils/gettingStartedDocs/python');
+  return {
+    ...original,
+    // Mock any functions causing circular dependencies
+    getPythonProfilingOnboarding: jest.fn(),
+  };
+});
+
+import {getPythonInstallSnippet} from 'sentry/utils/gettingStartedDocs/python';
+
+describe('getPythonInstallSnippet', () => {
+  it('generates install commands with default parameters', () => {
+    const result = getPythonInstallSnippet({
+      packageName: 'sentry-sdk',
+    });
+
+    expect(result.pip).toBe(`pip install "sentry-sdk"`);
+    expect(result.uv).toBe(`uv add "sentry-sdk"`);
+    expect(result.poetry).toBe(`poetry add "sentry-sdk"`);
+  });
+
+  it('generates pip install command with minimum version and extras', () => {
+    const result = getPythonInstallSnippet({
+      packageName: 'sentry-sdk[with-extras]',
+      minimumVersion: '2.3.4',
+    });
+    expect(result.pip).toBe(`pip install --upgrade "sentry-sdk[with-extras]>=2.3.4"`);
+    expect(result.uv).toBe(`uv add --upgrade "sentry-sdk[with-extras]>=2.3.4"`);
+    expect(result.poetry).toBe(`poetry add "sentry-sdk[with-extras]>=2.3.4"`);
+  });
+});
diff --git a/static/app/utils/gettingStartedDocs/python.tsx b/static/app/utils/gettingStartedDocs/python.tsx
@@ -12,36 +12,38 @@ import {t, tct} from 'sentry/locale';
 
 export function getPythonInstallSnippet({
   packageName,
-  packageManager = 'pip',
   minimumVersion,
 }: {
   packageName: string;
   minimumVersion?: string;
-  packageManager?: 'pip' | 'uv';
 }) {
+  // We are using consistent double quotes here for all package managers after aligning with the Python SDK team.
+  // Not using quotes may lead to some shells interpreting the square brackets, and using double quotes over single quotes is a convention.
   const versionedPackage = minimumVersion
-    ? `${packageName}>=${minimumVersion}`
-    : packageName;
+    ? `"${packageName}>=${minimumVersion}"`
+    : `"${packageName}"`;
 
   const upgradeFlag = minimumVersion ? '--upgrade ' : '';
 
   const packageManagerCommands = {
     uv: `uv add ${upgradeFlag}${versionedPackage}`,
     pip: `pip install ${upgradeFlag}${versionedPackage}`,
+    poetry: `poetry add ${versionedPackage}`,
   };
 
-  return packageManagerCommands[packageManager].trim();
+  return packageManagerCommands;
 }
 
 export function getPythonInstallConfig({
-  packageName = "'sentry-sdk'",
+  packageName = 'sentry-sdk',
   description,
   minimumVersion,
 }: {
   description?: React.ReactNode;
   minimumVersion?: string;
   packageName?: string;
 } = {}): Configuration[] {
+  const packageManagerCommands = getPythonInstallSnippet({packageName, minimumVersion});
   return [
     {
       description,
@@ -51,21 +53,19 @@ export function getPythonInstallConfig({
           label: 'pip',
           value: 'pip',
           language: 'bash',
-          code: getPythonInstallSnippet({
-            packageName,
-            packageManager: 'pip',
-            minimumVersion,
-          }),
+          code: packageManagerCommands.pip,
         },
         {
           label: 'uv',
           value: 'uv',
           language: 'bash',
-          code: getPythonInstallSnippet({
-            packageName,
-            packageManager: 'uv',
-            minimumVersion,
-          }),
+          code: packageManagerCommands.uv,
+        },
+        {
+          label: 'poetry',
+          value: 'poetry',
+          language: 'bash',
+          code: packageManagerCommands.poetry,
         },
       ],
     },
@@ -93,7 +93,7 @@ export function getPythonAiocontextvarsConfig({
   );
 
   return getPythonInstallConfig({
-    packageName: "'aiocontextvars'",
+    packageName: 'aiocontextvars',
     description: description ?? defaultDescription,
   });
 }

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ const onboarding: OnboardingConfig = {`
`72`	`72`	`code: <code />,`
`73`	`73`	`}`
`74`	`74`	`),`
`75`		`- configurations: getPythonInstallConfig({packageName: "'sentry-sdk[bottle]'"}),`
	`75`	`+ configurations: getPythonInstallConfig({packageName: 'sentry-sdk[bottle]'}),`
`76`	`76`	`},`
`77`	`77`	`],`
`78`	`78`	`configure: (params: Params) => [`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ const onboarding: OnboardingConfig = {`
`77`	`77`	`code: <code />,`
`78`	`78`	`}`
`79`	`79`	`),`
`80`		`- configurations: getPythonInstallConfig({packageName: "'sentry-sdk[chalice]'"}),`
	`80`	`+ configurations: getPythonInstallConfig({packageName: 'sentry-sdk[chalice]'}),`
`81`	`81`	`},`
`82`	`82`	`],`
`83`	`83`	`configure: (params: Params) => [`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ const onboarding: OnboardingConfig = {`
`68`	`68`	`code: <code />,`
`69`	`69`	`}`
`70`	`70`	`),`
`71`		`- configurations: getPythonInstallConfig({packageName: "'sentry-sdk[django]'"}),`
	`71`	`+ configurations: getPythonInstallConfig({packageName: 'sentry-sdk[django]'}),`
`72`	`72`	`},`
`73`	`73`	`],`
`74`	`74`	`configure: (params: Params) => [`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ const onboarding: OnboardingConfig = {`
`73`	`73`	`code: <code />,`
`74`	`74`	`}`
`75`	`75`	`),`
`76`		`- configurations: getPythonInstallConfig({packageName: "'sentry-sdk[falcon]'"}),`
	`76`	`+ configurations: getPythonInstallConfig({packageName: 'sentry-sdk[falcon]'}),`
`77`	`77`	`},`
`78`	`78`	`],`
`79`	`79`	`configure: (params: Params) => [`
Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ const onboarding: OnboardingConfig = {`
`75`	`75`	`code: <code />,`
`76`	`76`	`}`
`77`	`77`	`),`
`78`		`- configurations: getPythonInstallConfig({packageName: "'sentry-sdk[fastapi]'"}),`
	`78`	`+ configurations: getPythonInstallConfig({packageName: 'sentry-sdk[fastapi]'}),`
`79`	`79`	`},`
`80`	`80`	`],`
`81`	`81`	`configure: (params: Params) => [`
Original file line number	Diff line number	Diff line change
`@@ -74,7 +74,7 @@ const onboarding: OnboardingConfig = {`
`74`	`74`	`code: <code />,`
`75`	`75`	`}`
`76`	`76`	`),`
`77`		`- configurations: getPythonInstallConfig({packageName: "'sentry-sdk[flask]'"}),`
	`77`	`+ configurations: getPythonInstallConfig({packageName: 'sentry-sdk[flask]'}),`
`78`	`78`	`},`
`79`	`79`	`],`
`80`	`80`	`configure: (params: Params) => [`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ const onboarding: OnboardingConfig = {`
`47`	`47`	`code: <code />,`
`48`	`48`	`}`
`49`	`49`	`),`
`50`		`- configurations: getPythonInstallConfig({packageName: "'sentry-sdk[pymongo]'"}),`
	`50`	`+ configurations: getPythonInstallConfig({packageName: 'sentry-sdk[pymongo]'}),`
`51`	`51`	`},`
`52`	`52`	`],`
`53`	`53`	`configure: (params: Params) => [`