edits for new Jupyter notebook and updated code files (2026.03)

Author: kaponte75

examples/pzmm_id_code_file_example.ipynb

@@ -7,28 +7,34 @@
    "source": [
     "# Creating Python Code Files for SAS Intelligent Decisioning\n",
     "\n",
-    "This notebook demonstrates how to use the `CodeFile` class to upload Python code files formatted for SAS Intelligent Decisioning.\n",
+    "This notebook demonstrates how to use the `CodeFile` class to upload Python code\n",
+    "files that are properly formatted for use with SAS Intelligent Decisioning.\n",
     "\n",
     "## Overview\n",
     "\n",
+    "SAS Intelligent Decisioning requires Python code files to follow a specific format.\n",
     "\n",
-    "SAS Intelligent Decisioning (ID) requires Python code files to follow a specific format for detailed specifications on Python code file format requirements for SAS Intelligent Decisioning, see the [Rules For Developing Python Code Files](https://go.documentation.sas.com/doc/en/edmcdc/v_063/edmug/n04vfc1flrz8jsn1o5jblnbgx6i3.htm#n0jrohir6wzvd0n11omfautducm3) documentation.\n",
+    "Here is a high-level summary of the formatting requirements:\n",
     "\n",
-    "A basic overview:\n",
     "- An `execute` function is required\n",
-    "- An `Output:` docstring listing output variables as first line in the execute function\n",
-    "- A `DependentPackages:` docstring listing required packages at the top of the file including all non built-in packages needed\n",
+    "- An `Output:` docstring listing output variables as the first line in the execute function\n",
+    "- A `DependentPackages:` docstring listing required packages at the top of the file including packages that are needed but are not built-in\n",
     "- Must return standard Python data types\n",
     "\n",
     "\n",
     "The `CodeFile` class validates and uploads properly formatted Python code to SAS Viya.\n",
     "\n",
+    "For more information about formating requirements for Python code files, see the [Rules\n",
+    "For Developing Python Code\n",
+    "Files](https://documentation.sas.com/?cdcId=edmcdc&cdcVersion=default&docsetId=edmug&docsetTarget=n04vfc1flrz8jsn1o5jblnbgx6i3.htm#n0jrohir6wzvd0n11omfautducm3)\n",
+    "in _SAS Intelligent Decisioning: User's Guide_.\n",
+    "\n",
     "## Prerequisites\n",
     "\n",
-    "- A SAS Viya environment with Intelligent Decisioning\n",
+    "- SAS Viya environment with SAS Intelligent Decisioning\n",
     "- Appropriate permissions to create files in the target folder\n",
     "- sasctl package installed\n",
-    "- Python code already formatted according to ID requirements"
+    "- Python code already formatted according to SAS Intelligent Decisioning requirements"
    ]
   },
   {
@@ -44,31 +50,14 @@
    "execution_count": null,
    "id": "e27dcadc",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stderr",
-     "output_type": "stream",
-     "text": [
-      "/Users/sababa/Desktop/repos/python-sasctl/venv3.11/lib/python3.11/site-packages/urllib3/connectionpool.py:1097: InsecureRequestWarning: Unverified HTTPS request is being made to host 'base.ingress-nginx.sababa-dq1-m1.modelmanager.sashq-d.openstack.sas.com'. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#tls-warnings\n",
-      "  warnings.warn(\n"
-     ]
-    },
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Connected to https://base.ingress-nginx.sababa-dq1-m1.modelmanager.sashq-d.openstack.sas.com/\n",
-      "Folder already exists. HTTP Error 409: {\"version\":2,\"httpStatusCode\":409,\"errorCode\":11552,\"message\":\"An item named \\\"ID_python_files\\\" of type \\\"Folder\\\" already exists in the folder \\\"Public\\\".\",\"details\":[\"Existing member: \",\"/folders/folders/3789dfcd-a5a6-4836-85d9-beb5f812baf8\",\"Suggestion: ID_python_files (1)\",\"path: /folders/folders\",\"correlator: 58004f45-b0cb-4737-adb1-1edbfba2040c\"]}\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "from sasctl import Session\n",
     "from sasctl.pzmm import CodeFile\n",
     "from sasctl.services import folders as folder_service\n",
     "\n",
     "\n",
-    "# Replace with your SAS Viya connection details\n",
+    "# Replace with your SAS Viya connection information\n",
     "HOST = 'your-viya-host.com'\n",
     "USERNAME = 'your-username'\n",
     "PASSWORD = 'your-password'\n",
@@ -90,27 +79,17 @@
    "source": [
     "## Example 1: Simple Code File\n",
     "\n",
-    "Let's start with a simple example that performs a basic calculation."
+    "Here is a simple example that performs a basic calculation."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "id": "fa33286d",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "File uploaded successfully!\n",
-      "File ID: 5169bfbe-4ba4-4998-b9c3-24228add86a7\n",
-      "File Name: simple_calculator\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
-    "# Define properly formatted ID Python code\n",
+    "# Define properly formatted Python code\n",
     "simple_code = \"\"\"\n",
     "def execute(input_value):\n",
     "    '''Output: score, category'''\n",
@@ -120,14 +99,14 @@
     "    return score, category\n",
     "\"\"\"\n",
     "\n",
-    "# Upload the code file to Viya\n",
+    "# Upload the code file to SAS Viya\n",
     "file_obj = CodeFile.write_id_code_file(\n",
     "    code=simple_code,\n",
     "    file_name='simple_calculator.py',\n",
     "    folder='/Public/ID_python_files'\n",
     ")\n",
     "\n",
-    "print(f\"File uploaded successfully!\")\n",
+    "print(f\"The file was uploaded successfully.\")\n",
     "print(f\"File ID: {file_obj.id}\")\n",
     "print(f\"File Name: {file_obj.name}\")"
    ]
@@ -139,25 +118,15 @@
    "source": [
     "## Example 2: Code File with API Call\n",
     "\n",
-    "This example shows how to create a code file that makes an API call to retrieve data."
+    "Here is an example of how to create a code file that makes an API call to retrieve data."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": null,
    "id": "6608730a",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "File uploaded successfully!\n",
-      "File ID: 7484adcd-3121-4e13-b208-c7b1ef51e444\n",
-      "File Name: risk_score_api\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "api_code = \"\"\"\n",
     "'''DependentPackages: requests'''\n",
@@ -188,9 +157,9 @@
     "    folder='/Public/ID_python_files'\n",
     ")\n",
     "\n",
-    "print(f\"File uploaded successfully!\")\n",
+    "print(f\"The file was uploaded successfully.\")\n",
     "print(f\"File ID: {file_obj.id}\")\n",
-    "print(f\"File Name: {file_obj.name}\")"
+    "print(f\"File name: {file_obj.name}\")"
    ]
   },
   {
@@ -200,23 +169,15 @@
    "source": [
     "## Example 3: Code with Multiple Dependencies\n",
     "\n",
-    "Specify multiple packages in the DependentPackages docstring."
+    "Here is an example of specifying multiple packages in the `DependentPackages` docstring."
    ]
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": null,
    "id": "48f441ff",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "File uploaded successfully: data_processor\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "data_processing_code = \"\"\"\n",
     "'''DependentPackages: pandas, numpy'''\n",
@@ -234,7 +195,7 @@
     "    mean_value = float(np.mean(data['values']))\n",
     "    std_value = float(np.std(data['values']))\n",
     "    result = 'Pass' if mean_value > threshold else 'Fail'\n",
-    "    \n",
+    "\n",
     "    return mean_value, std_value, result\n",
     "\"\"\"\n",
     "\n",
@@ -245,7 +206,7 @@
     "    folder='/Public/ID_python_files'\n",
     ")\n",
     "\n",
-    "print(f\"File uploaded successfully: {file_obj.name}\")"
+    "print(f\"This file was uploaded successfully: {file_obj.name}\")"
    ]
   },
   {
@@ -255,23 +216,15 @@
    "source": [
     "## Example 4: Reading Code from a File\n",
     "\n",
-    "You can also read Python code from an existing file."
+    "Here is an example of reading Python code from an existing file."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "id": "eb8ad79d",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Uploaded code from file: credit_decision\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "from pathlib import Path\n",
     "\n",
@@ -298,7 +251,7 @@
     "# Clean up\n",
     "temp_code_file.unlink()\n",
     "\n",
-    "print(f\"Uploaded code from file: {file_obj.name}\")"
+    "print(f\"Code uploaded from file: {file_obj.name}\")"
    ]
   },
   {
@@ -308,26 +261,15 @@
    "source": [
     "## Example 5: Code File with No Parameters\n",
     "\n",
-    "You can also create code files that don't require input parameters."
+    "Here is an example of creating code files that do not require input parameters."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "id": "460f264f",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "WARNING: About to delete existing file: config_info.py\n",
-      "This may result in loss of sensitive data or configurations.\n",
-      "Deleted existing file: config_info.py\n",
-      "Configuration code file created: config_info\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "from sasctl.services import files as file_service\n",
     "from sasctl.services import folders as folder_service\n",
@@ -341,12 +283,12 @@
     "    current_date = datetime.datetime.now().strftime('%Y-%m-%d')\n",
     "    environment = 'production'\n",
     "    version = '1.0.0'\n",
-    "    \n",
+    "\n",
     "    return current_date, environment, version\n",
     "\"\"\"\n",
     "\n",
-    "# Check if file already exists and delete it\n",
-    "# WARNING: Deleting files may result in loss of important data or configurations.\n",
+    "# Check if file already exists and delete it.\n",
+    "# Warning: Deleting files might result in loss of important data or configurations.\n",
     "# Ensure you have backups or that the file can be safely removed before proceeding.\n",
     "\n",
     "file_name = 'config_info.py'\n",
@@ -361,13 +303,13 @@
     "            params={\"filter\": file_filter}\n",
     "        )\n",
     "        if len(existing_file) > 0:\n",
-    "            print(f\"WARNING: About to delete existing file: {file_name}\")\n",
-    "            print(\"This may result in loss of sensitive data or configurations.\")\n",
+    "            print(f\"Warning: You are about to delete this file: {file_name}\")\n",
+    "            print(\"This action might result in loss of sensitive data or configurations.\")\n",
     "\n",
     "            file_service.delete_file({\"id\": existing_file['uri'].split('/')[-1]})\n",
-    "            print(f\"Deleted existing file: {file_name}\")\n",
+    "            print(f\"Deleted file: {file_name}\")\n",
     "except Exception as e:\n",
-    "    print(f\"No existing file found: {file_name} {e}\")\n",
+    "    print(f\"This file was not found: {file_name} {e}\")\n",
     "\n",
     "\n",
     "file_obj = CodeFile.write_id_code_file(\n",
@@ -386,24 +328,19 @@
    "source": [
     "## Example 6: Disable Validation\n",
     "\n",
-    "You can skip pre-upload validation **Note:** The file will still be uploaded even if it has formatting errors - those errors will appear later when you try to use the file in a decision. You can view the codeFile in Intelligent Decisioning and validate it to check."
+    "Here is an example of skipping pre-upload validation.\n",
+    "\n",
+    "**Note:** The file will still be uploaded even if it contains formatting errors.\n",
+    "The errors appear later when you try to use the file in a decision. You can\n",
+    "view the code file in SAS Intelligent Decisioning and validate it to check for errors."
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
    "id": "95855524",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "File uploaded without pre-validation: fast_calculator\n",
-      "Warning: If there are formatting errors, they will appear when you use the file in a decision.\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "fast_code = \"\"\"\n",
     "def execute(input_a, input_b):\n",
@@ -413,7 +350,7 @@
     "\"\"\"\n",
     "\n",
     "# Skip pre-upload validation for faster upload\n",
-    "# File will still be created even if there are formatting errors\n",
+    "# File is still created when there are formatting errors\n",
     "file_obj = CodeFile.write_id_code_file(\n",
     "    code=fast_code,\n",
     "    file_name='fast_calculator.py',\n",
@@ -437,18 +374,10 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 16,
+   "execution_count": null,
    "id": "4a1f6b08",
    "metadata": {},
-   "outputs": [
-    {
-     "name": "stdout",
-     "output_type": "stream",
-     "text": [
-      "Session closed\n"
-     ]
-    }
-   ],
+   "outputs": [],
    "source": [
     "# Close the session\n",
     "sess.close()\n",
@@ -462,8 +391,8 @@
    "source": [
     "## Additional Resources\n",
     "\n",
-    "- [SAS Intelligent Decisioning Documentation](https://go.documentation.sas.com/doc/en/edmcdc/v_063/edmug/n04vfc1flrz8jsn1o5jblnbgx6i3.htm)\n",
-    "- [Rules For Developing Python Code Files](https://go.documentation.sas.com/doc/en/edmcdc/v_063/edmug/n04vfc1flrz8jsn1o5jblnbgx6i3.htm#n0jrohir6wzvd0n11omfautducm3)\n",
+    "- [SAS Intelligent Decisioning Documentation](https://documentation.sas.com/?cdcId=edmcdc&cdcVersion=default&docsetId=edmug&docsetTarget=n04vfc1flrz8jsn1o5jblnbgx6i3.htm)\n",
+    "- [Rules For Developing Python Code Files](https://documentation.sas.com/?cdcId=edmcdc&cdcVersion=default&docsetId=edmug&docsetTarget=n04vfc1flrz8jsn1o5jblnbgx6i3.htm#n0jrohir6wzvd0n11omfautducm3)\n",
     "- [python-sasctl Documentation](https://sassoftware.github.io/python-sasctl/)"
    ]
   }

src/sasctl/_services/files.py

@@ -20,8 +20,8 @@ class Files(Service):
     The file can be associated with the URI of another identifiable object
     (for example, a parentUri). Every file must have an assigned content type
     and name. Files can be retrieved individually by using the file's
-    identifier or as a list of files by using a parentUri. Each file has its
-    content stream associated with it.  After creation, the metadata that is
+    identifier or as a list of files by using a parentUri. Each file is
+    associated with its content stream. After creation, the metadata that is
     associated with the file or the actual content can be updated. A single
     file can be deleted by using a specific ID. Multiple files can be deleted
     by specifying a parentUri.  A file can be uploaded via raw request or