This release is a pre-release and may not be stable for production use.
AVEVA Data Hub Python Library Sample
| :loudspeaker: Notice: This library is an AVEVA Data Hub targeted version of the ocs_sample_library_preview. The ocs_sample_library_preview library is being deprecated and this library should be used moving forward. |
|---|
Version: 0.10.19_preview
This sample library requires Python 3.7+. You can download Python here.
- NOTE: The library previously required Python 3.9+ to take advantage of type annotations. To provide compatibility with environments that cannot upgrade Python to 3.9,
from __future__ import annotationswas added to each necessary file. This provides backwards compatibility down to Python 3.7.
About the library
The python ADH library is an introductory language-specific example of programming against Aveva Data Hub (ADH). It is intended as instructional samples only and are not for production use. The samples also work on OSIsoft Cloud Services unless otherwise noted.
They can be obtained by running: pip install adh_sample_library_preview
The library is not intended to show every endpoint and every option/parameter for endpoints it has. The library is known to be incomplete.
Other language libraries and samples are available on GitHub.
Testing
The library is tested using PyTest. To test locally, make sure that PyTest is installed, then navigate to the Tests directory and run the test classes by executing
python -m pytest {testclass}
where {testclass} is the name of a test class, for example ./test_baseclient.py.
Optionally to run end to end tests, rename the appsettings.placeholder.json file to appsettings.json and populate the fields, (This file is included in the gitignore and will not be pushed to a remote repository), then run
python -m pytest {testclass} --e2e True
Logging
Every request made by the library is logged using the standard Python logging library. If the client application using the library creates a logger, then library will log to it at the following levels:
| Level | Usage |
|---|---|
| Error | any non 200-level response code, along with the error message |
| Info | all request urls and verbs all response status codes |
| Debug | data payload and all request headers (Authorization header value redacted) response content and all response headers |
The process for creating a logger is described in the Logging HOWTO documentation.
An example walkthrough is shown here:
Logger Creation Example
To initiate logging, the client must create a logger, defining a log file, a desired log level, and default formatting:
# Step 0 - set up logger
log_file = 'logfile.txt'
log_level = logging.INFO
logging.basicConfig(filename=log_file, encoding='utf-8', level=log_level, datefmt='%Y-%m-%d %H:%M:%S',
format='%(asctime)s %(module)16s,line: %(lineno)4d %(levelname)8s | %(message)s')
This creates a logger object that streams any logged messages to the desired output. The libraries called by the client, including this ADH Sample Library Python, that have implemented logging will send their messages to this logger automatically.
The log level specified will result in any log at that level or higher to be logged. For example, INFO captures INFO, WARNING, ERROR, and CRITICAL, but ignores DEBUG.
Logger Usage Example
To change the log level after creation, the level can be set using the following command
logging.getLogger().setLevel(logging.DEBUG)
This concept is particularly helpful when debugging a specific call within the application. Logging can be changed before and after a call to the library in order to provide debug logs for that specific call only, without flooding the logs with debug entries for every other call to the library.
An example of this can be seen here.
# Step 4 - Retrieve the data view
original_level = logging.getLogger().level
logging.getLogger().setLevel(logging.DEBUG)
dataview = adh_client.DataViews.getDataView(
namespace_id, SAMPLE_DATAVIEW_ID)
logging.getLogger().setLevel(original_level)
Note that the original level was recorded, logging was set to debug, the getDataView call was performed, then logging was set to its previous level. The logs will contain debug message for only this call, and all other calls before and after will be logged with their original level.
Developed using Python 3.10.1
AVEVA Samples are licensed under the Apache 2 license.
For the main ADH sample libraries page ReadMe
For the main AVEVA samples page ReadMe
1 maintainer
Metadata
1 maintainer
Release files for adh-sample-library-preview 0.10.19rc0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| adh_sample_library_preview-0.10.19rc0.tar.gz | 87.7 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| adh_sample_library_preview-0.10.19rc0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 246.6 kB
Release files / adh_sample_library_preview-0.10.19rc0.tar.gz
| Download URL | adh_sample_library_preview-0.10.19rc0.tar.gz |
|---|---|
| Size | 87.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8eb012ffe0d288d747ce599601cea5072b3ce1126864e976c6e0b3299361e8fe
|
|
BLAKE2b-256 checksum How to use checksums |
be53b9c6f184678daed937de590b2207c7cfa67a4c2cf1230252129fc5839d3d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.12
|
Release files / adh_sample_library_preview-0.10.19rc0-py3-none-any.whl
| Download URL | adh_sample_library_preview-0.10.19rc0-py3-none-any.whl |
|---|---|
| Size | 158.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e0ad708eff36215998448a7e2351d945113d4eedb4ea3c18763c8eed1df62a80
|
|
BLAKE2b-256 checksum How to use checksums |
28aa336fa0089da9c63860c41ca965688a617d7e6f9eeb1447ce5f2746c0799d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.10.12
|
Security for adh-sample-library-preview 0.10.19rc0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
