Merge pull request #13 from RohithSurya/features/readfile_docs_32199_…

…32200

WIP: [#32200] Commit show command, Move ReadFile getData API calls to JSON

.github/workflows/pytest-coverage.yaml

@@ -1,8 +1,5 @@
 name: Test Coverage
 on: 
-  push:
-    branches:
-      main
   pull_request:
     branches:
       main

.gitignore

@@ -133,4 +133,6 @@ dmypy.json
 tests/my_secret.py
 
 # Miscellaneous folders
-Dummy/
+Dummy/
+
+docs/build

examples/file_exists.py

@@ -0,0 +1,37 @@
+from pyhpcc.models.auth import Auth
+from pyhpcc.models.file import ReadFileInfo
+from pyhpcc.models.hpcc import HPCC
+
+# Code to check if a logical file exists
+
+# Configurations
+environment = (
+    "university.us-hpccsystems-dev.azure.lnrsg.io"  # Eg: myuniversity.hpccsystems.io
+)
+port = "8010"  # Eg: 8010
+user_name = "dummyusername"  # HPCC username
+password = "dummypassword"  # HPCC password
+protocol = "http"  # Specify HTTP or HTTPS p
+cluster = "thor"  # Specify the cluster name to be used
+logical_file = "pyhpcc::testing::internet.csv"
+
+try:
+    auth_object = Auth(
+        environment,
+        port,
+        user_name,
+        password,
+        protocol=protocol,
+    )
+    hpcc_object = HPCC(auth=auth_object)
+    read_file = ReadFileInfo(
+        hpcc=hpcc_object,
+        logical_file_name=logical_file,
+        cluster=cluster,
+        file_type="flat",
+    )
+
+    print(read_file.check_file_in_dfu())  # Prints `True` if file exists else `False`
+
+except Exception as e:
+    print(e)

examples/read_file.py

@@ -0,0 +1,35 @@
+from pyhpcc.models.auth import Auth
+from pyhpcc.models.file import ReadFileInfo
+from pyhpcc.models.hpcc import HPCC
+
+# Example illustrating how to read a logical file
+
+# Configurations
+environment = (
+    "university.us-hpccsystems-dev.azure.lnrsg.io"  # Eg: myuniversity.hpccsystems.io
+)
+port = "8010"  # Eg: 8010
+user_name = "dummy username"  # HPCC username
+password = "password"  # HPCC password
+protocol = "http"  # Specify HTTP or HTTPS p
+cluster = "thor"  # Specify the cluster name to be used
+logical_file = "pyhpcc::em::test::emp"
+
+try:
+    auth_object = Auth(
+        environment,
+        port,
+        user_name,
+        password,
+        protocol=protocol,
+    )
+    hpcc_object = HPCC(auth=auth_object)
+    read_file = ReadFileInfo(hpcc=hpcc_object, logical_file_name=logical_file)
+
+    # Retrieves all records with a `batch_size` of 2. To retrieve all records in one go, set the batch_size to a large number
+    for data_attr, data in read_file.get_data_iter(0, -1, 2):
+        print(data_attr)
+        print(data)
+
+except Exception as e:
+    print(e)

pyproject.toml

@@ -19,6 +19,7 @@ elementpath = "^3.0.2" # XPath selectors for XML Data structures
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.1.3"
 pytest-mock = "^3.0.2"
+pytest-dependency="^0.6.0"
 pre-commit="^3.7.1"
 
 [tool.poetry.group.coverage.dependencies]

src/pyhpcc/config.py

@@ -44,6 +44,13 @@
     "-v",
     "--verbose",
 ]
+RUN_UNWANTED_PATTERNS = [
+    r"jsocket\([0-9]+,[0-9]+\) ",
+    "deploying",
+    "Deployed",
+    "Running",
+    "Using eclcc path ",
+]
 MASKED_PASSWORD = "*****"
 RUN_AUTH_OPTIONS = {*USER_OPTIONS, *PASSWORD_OPTIONS, *SERVER_OPTIONS, PORT_OPTION}
 

src/pyhpcc/handlers/roxie_handler.py

@@ -1,5 +1,7 @@
 import logging
 
+from requests.models import Response
+
 import pyhpcc.config as conf
 from pyhpcc.errors import HPCCAuthenticationError
 from pyhpcc.utils import convert_arg_to_utf8_str
@@ -145,7 +147,7 @@ def execute(self):
                 auth = self.api.auth.oauth
 
             # Execute request
-            resp = self.session.request(
+            resp: Response = self.session.request(
                 self.method,
                 full_url,
                 data=self.post_data,

src/pyhpcc/handlers/thor_handler.py

@@ -1,5 +1,7 @@
 import logging
 
+from requests.models import Response
+
 import pyhpcc.config as conf
 from pyhpcc.errors import HPCCAuthenticationError
 from pyhpcc.utils import convert_arg_to_utf8_str
@@ -152,7 +154,7 @@ def execute(self):
             if self.api.auth:
                 auth = self.api.auth.oauth
 
-            resp = self.session.request(
+            resp: Response = self.session.request(
                 self.method,
                 full_url,
                 data=self.data,