feat: Add Posit product environment check helpers by mconflitti-pbc · Pull Request #391 · posit-dev/posit-sdk-py

mconflitti-pbc · 2025-02-26T15:13:05Z

Fixes #389

github-actions · 2025-02-26T15:16:20Z

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines	Covered	Coverage	Threshold	Status
1827	1715	94%	0%	🟢

New Files

File	Coverage	Status
src/posit/environment.py	100%	🟢
TOTAL	100%	🟢

Modified Files

File	Coverage	Status
src/posit/connect/_utils.py	78%	🟢
src/posit/connect/client.py	99%	🟢
src/posit/connect/external/databricks.py	91%	🟢
src/posit/connect/external/snowflake.py	91%	🟢
TOTAL	90%	🟢

updated for commit: 20457c4 by action🐍

tdstein

Everything looks good. Thanks for adding the deprecation warning! Ready to approve, but want to get your thoughts on runtime vs environment for the module name.

src/posit/environment.py

tdstein · 2025-02-26T16:13:15Z

src/posit/environment.py

+from __future__ import annotations
+
+import os
+
+
+def get_product() -> str | None:
+    """Returns the product name if called with a Posit product.
+
+    The products will always set the environment variable `POSIT_PRODUCT=<product-name>`
+    or `RSTUDIO_PRODUCT=<product-name>`.
+
+    RSTUDIO_PRODUCT is deprecated and acts as a fallback for backwards compatibility.
+    It is recommended to use POSIT_PRODUCT instead.
+    """
+    return os.getenv("POSIT_PRODUCT") or os.getenv("RSTUDIO_PRODUCT")
+
+
+def is_local() -> bool:
+    """Returns true if called while running locally."""
+    return get_product() is None
+
+
+def is_running_on_connect() -> bool:
+    """Returns true if called from a piece of content running on a Connect server."""
+    return get_product() == "CONNECT"
+
+
+def is_running_on_workbench() -> bool:
+    """Returns true if called from within a Workbench server."""
+    return get_product() == "WORKBENCH"


Do we need to support dynamic environment variables here? Another option is to use static variables.

from __future__ import annotations import os POSIT_PRODUCT = os.getenv("POSIT_PRODUCT") or os.getenv("RSTUDIO_PRODUCT") IS_POSIT_CONNECT = POSIT_PRODUCT == "CONNECT" IS_POSIT_WORKBENCH = POSIT_PRODUCT == "WORKBENCH"

Then from external.databricks/snowflake...

from .. import runtime if not runtime.POSIT_PRODUCT: return;

Feel free to disregard this if you have already thought through it.

this is great feedback. did not consider this.

i think i could go either way here. your approach is definitely simpler. let me ensure its testable. i would think just importing the module should trigger this to run but can check.

The connectapi and connectcreds equivalents are functions so followed suit but i like simple :)

I think this might be a little misleading for users today since workbench doesn't support this var yet.

I haven't tested this on workbench yet but I'm expecting to do something like this:

posit-sdk-py/src/posit/connect/_utils.py

Lines 35 to 45 in a089705

def is_workbench() -> bool:

"""Attempts to return true if called from a piece of content running on Posit Workbench.

There is not yet a definitive way to determine if the content is running on Workbench. This method is best-effort.

"""

return (

"RSW_LAUNCHER" in os.environ

or "RSTUDIO_MULTI_SESSION" in os.environ

or "RS_SERVER_ADDRESS" in os.environ

or "RS_SERVER_URL" in os.environ

)

I think the functional approach is going to best here, especially from a testing perspective. Complicates things when the values are set upon import. Going to keep it functional.

@dbkegley yeah that is fine! can add these checks into the workbench runtime check

@atheriel, do you have any thoughts here?

Always the option punt and not have any workbench related check for now.

tdstein · 2025-02-26T16:15:54Z

src/posit/environment.py

+    return os.getenv("POSIT_PRODUCT") or os.getenv("RSTUDIO_PRODUCT")
+
+
+def is_local() -> bool:


I suppose is_local is a little subjective since their application could run elsewhere that isn't their machine or Posit.

i like your suggestion above. will leave deprecation warning in utils is_local but can map it use the global vars.

going to keep this since staying with functional approach

mconflitti-pbc · 2025-02-26T17:08:39Z

@zackverham and @dbkegley after looking at the existing is_local function, it was only checking if POSIT_PRODUCT is not set to CONNECT. So it would be considered local if running on workbench. Is that the intended effect?

dbkegley · 2025-02-26T18:28:34Z

@zackverham and @dbkegley after looking at the existing is_local function, it was only checking if POSIT_PRODUCT is not set to CONNECT. So it would be considered local if running on workbench. Is that the intended effect?

That was the intent initially but now that we need a better way to differentiate between Connect vs Workbench vs elsewhere the original implementation no longer seems correct.

mconflitti-pbc · 2025-02-26T18:51:07Z

@zackverham and @dbkegley after looking at the existing is_local function, it was only checking if POSIT_PRODUCT is not set to CONNECT. So it would be considered local if running on workbench. Is that the intended effect?

That was the intent initially but now that we need a better way to differentiate between Connect vs Workbench vs elsewhere the original implementation no longer seems correct.

Okay cool. This PR should address that then to ensure it is not connect nor workbench to be local.

tdstein · 2025-03-20T20:05:43Z

@mconflitti-pbc - are we still trying to move forward with this?

mconflitti-pbc · 2025-03-20T20:58:07Z

@mconflitti-pbc - are we still trying to move forward with this?

Not something that is likely to get addressed before the march release given I need to coordinate these changes across a few SDKs and there is some context missing to ensure this is done properly.

tdstein · 2025-03-20T21:34:31Z

Should we close this PR and open a new one when ready? Changing it back to a draft also works.

add environment check helpers

a73f8ef

mconflitti-pbc requested review from schloerke and toph-allen February 26, 2025 15:13

mconflitti-pbc requested a review from tdstein as a code owner February 26, 2025 15:13

mconflitti-pbc added 2 commits February 26, 2025 10:14

lint fixes

1eedd74

fix tests

20457c4

tdstein reviewed Feb 26, 2025

View reviewed changes

mconflitti-pbc marked this pull request as draft March 21, 2025 01:27

	def is_workbench() -> bool:
	"""Attempts to return true if called from a piece of content running on Posit Workbench.

	There is not yet a definitive way to determine if the content is running on Workbench. This method is best-effort.
	"""
	return (
	"RSW_LAUNCHER" in os.environ
	or "RSTUDIO_MULTI_SESSION" in os.environ
	or "RS_SERVER_ADDRESS" in os.environ
	or "RS_SERVER_URL" in os.environ
	)

		return os.getenv("POSIT_PRODUCT") or os.getenv("RSTUDIO_PRODUCT")


		def is_local() -> bool:

Conversation

mconflitti-pbc commented Feb 26, 2025

Uh oh!

github-actions bot commented Feb 26, 2025

☂️ Python Coverage

Overall Coverage

New Files

Modified Files

Uh oh!

tdstein left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dbkegley Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mconflitti-pbc commented Feb 26, 2025

Uh oh!

dbkegley commented Feb 26, 2025

Uh oh!

mconflitti-pbc commented Feb 26, 2025

Uh oh!

tdstein commented Mar 20, 2025

Uh oh!

mconflitti-pbc commented Mar 20, 2025

Uh oh!

tdstein commented Mar 20, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

dbkegley Feb 26, 2025 •

edited

Loading