Skip to content

Fix docs typos in StoredProcedureProfiler #3700

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sfc-gh-jfreeberg wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix docs typos in StoredProcedureProfiler #3700

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
15b3934
Fix docs typos in StoredProcedureProfiler
sfc-gh-jfreeberg Aug 25, 2025
e5bb705
Merge branch 'main' into sfc-gh-jfreeberg-patch-1
sfc-gh-jfreeberg Sep 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions src/snowflake/snowpark/stored_procedure_profiler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,15 @@ def __init__(
self._has_target_stage = False
self._is_enabled = False

def register_modules(self, stored_procedures: Optional[List[str]] = None) -> None:
def register_modules(self, modules: Optional[List[str]] = None) -> None:
"""
Register stored procedures to generate profiles for them.

Args:
stored_procedures: List of names of stored procedures. Registered modules will be overwritten by this input.
Input None or an empty list will remove registered modules.
modules: List of names of Python modules to profile. Any previously registered modules will be overwritten by this input. Set this to None or an empty list to remove all previously registered modules.
"""
sp_string = ",".join(stored_procedures) if stored_procedures is not None else ""
sql_statement = f"alter session set python_profiler_modules='{sp_string}'"
modules_string = ",".join(modules) if modules is not None else ""
sql_statement = f"alter session set python_profiler_modules='{modules_string}'"
self._session.sql(sql_statement)._internal_collect_with_tag_no_telemetry()

def set_target_stage(self, stage: str) -> None:
Expand Down Expand Up @@ -75,8 +74,7 @@ def set_active_profiler(
Set active profiler.

Args:
active_profiler_type: String that represent active_profiler, must be either 'LINE' or 'MEMORY'
(case-insensitive). Active profiler is 'LINE' by default.
active_profiler_type: String that represent active_profiler, must be either 'LINE' or 'MEMORY' (case-insensitive). Active profiler is 'LINE' by default.

"""
if not self._has_target_stage:
Expand Down
Loading