| Name | xtest-sapnwrfc JSON |
| Version |
0.0.17
JSON |
| download |
| home_page | |
| Summary | Python bindings for SAP NetWeaver RFC SDK |
| upload_time | 2023-04-25 10:46:59 |
| maintainer | |
| docs_url | None |
| author | SAP SE |
| requires_python | >=3.7 |
| license | Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. |
| keywords |
pyrfc
sap
nwrfc
sapnwrfc
abap
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h1>PyRFC</h1>
Asynchronous, non-blocking [SAP NetWeawer RFC SDK](https://support.sap.com/en/product/connectors/nwrfcsdk.html) bindings for Python.
[](https://opensource.org/licenses/Apache-2.0)
[](https://pypi.org/project/pyrfc/)
[](https://pypi.org/project/pyrfc/)
[](https://pypi.org/project/pyrfc/)
[](https://pypistats.org/packages/pyrfc)
[](https://api.reuse.software/info/github.com/SAP/PyRFC)
[](https://bestpractices.coreinfrastructure.org/projects/4349)
- [Features](#features)
- [Supported platforms](#supported-platforms)
- [Requirements](#requirements)
- [SAP NW RFC SDK 7.50.11](#sap-nw-rfc-sdk-75011)
- [Docker](#docker)
- [Windows](#windows)
- [macOS](#macos)
- [Download and installation](#download-and-installation)
- [Getting started](#getting-started)
- [Call ABAP Function Module from Python](#call-abap-function-module-from-python)
- [Call Python function from ABAP](#call-python-function-from-abap)
- [SPJ articles](#spj-articles)
- [How to obtain support](#how-to-obtain-support)
- [Contributing](#contributing)
- [License](#license)
## Features
- Client and Server bindings
- Automatic conversion between Python and ABAP datatypes
- Stateless and stateful connections (multiple function calls in the same ABAP session / same context)
- Sequential and parallel calls, using one or more clients
- Throughput monitoring
## Supported platforms
- All [platforms supported by SAP NWRFC SDK](https://launchpad.support.sap.com/#/notes/2573790) are supported by build from source installation ([build instructions](http://sap.github.io/PyRFC/build.html))
- In addition, pre-built wheels are provided for Windows, Darwin and Ubuntu Linux, attached to PyRFC GitHub [release](https://github.com/SAP/PyRFC/releases/latest)
- Docker containers: [SAP fundamental-tools/docker](https://github.com/SAP/fundamental-tools/tree/main/docker)
- Linux wheels supported by build from source installation only
- Pre-built [portable Linux wheels](https://www.python.org/dev/peps/pep-0513/)
- are not supported, neither issues related to portable Linux wheels
- **must not** be distributed with embedded SAP NWRFC SDK binaries, only private use permitted
## Requirements
### SAP NW RFC SDK 7.50.11
- see [SAP Note 3274546](https://launchpad.support.sap.com/#/notes/3274546) for a list of bug fixes and enhancements made with this patch release
- Using the latest version is recommended as SAP NWRFC SDK is fully backwards compatible, from today S4, down to R/3 release 4.6C.
- Can be downloaded from SAP Software Download Center of the SAP Support Portal, like described at https://support.sap.com/nwrfcsdk.
- If you are lacking the required authorization for downloading software from the SAP Service Marketplace, please follow the instructions of [SAP Note 1037575](https://launchpad.support.sap.com/#/notes/1037575) for requesting this authorization.
### Docker
- Docker container examples for Linux, Intel and ARM based Darwin: [SAP/fundamental-tools/docker](https://github.com/SAP/fundamental-tools/tree/main/docker). SAP NWRFC SDK libraries are not included.
### Windows
- [Visual C++ Redistributable Package for Visual Studio 2013](https://www.microsoft.com/en-US/download/details.aspx?id=40784) is required for runtime, see [SAP Note 2573790 - Installation, Support and Availability of the SAP NetWeaver RFC Library 7.50](https://launchpad.support.sap.com/#/notes/2573790)
- Build toolchain for Python 3 requires [Microsoft C++ Build Tools](https://aka.ms/buildtools), the latest version recommended
- Build toolchain for Python 2 requires [Microsoft Visual C++ 9.0](http://aka.ms/vcpython27)
- Due to a [change introduced with Python 3.8 for Windows](https://docs.python.org/3.8/whatsnew/3.8.html#bpo-36085-whatsnew), PATH directories are no longer searched for DLL. The SAP NWRFC SDK lib path is no longer required on PATH, for Python >= 3.8.
### macOS
- Remote paths must be set in SAP NWRFC SDK for macOS: [documentation](http://sap.github.io/PyRFC/install.html#macos)
- When the PyRFC is started for the first time, the popups may come-up for each NWRFC SDK library, to confirm the usage. If SAP NW RFC SDK is installed in admin folder, the app shall be first time started with admin privileges, eg. `sudo -E`
## Download and installation
```shell
pip install pyrfc
```
Cython must be installed upfront because the build from source is standard installation method on Linux.
Build from source can be requested also on other platforms:
```shell
pip install pyrfc --no-binary :all:
# or
PYRFC_BUILD_CYTHON=yes pip install pyrfc --no-binary :all:
```
Alternative build from source installation:
```shell
git clone https://github.com/SAP/PyRFC.git
cd PyRFC
python -m pip install .
# or
python -m build --wheel --sdist --outdir dist
pip install --upgrade --no-index --find-links=dist pyrfc
```
See also the [pyrfc documentation](http://sap.github.io/PyRFC),
complementing _SAP NWRFC SDK_[documentation](https://support.sap.com/nwrfcsdk), especially [SAP NWRFC SDK 7.50 Programming Guide](https://support.sap.com/content/dam/support/en_us/library/ssp/products/connectors/nwrfcsdk/NW_RFC_750_ProgrammingGuide.pdf).
## Getting started
**Note:** The package must be [installed](#download-and-installation) before use.
### Call ABAP Function Module from Python
In order to call remote enabled ABAP function module (ABAP RFM), first a connection must be opened.
```python
from pyrfc import Connection
conn = Connection(ashost='10.0.0.1', sysnr='00', client='100', user='me', passwd='secret')
```
Connection parameters are documented in `sapnwrfc.ini` file, located in the _SAP NWRFC SDK_ `demo` folder. Check also section `4.1.2 Using sapnwrfc.ini` of [SAP NWRFC SDK 7.50 Programming Guide](https://support.sap.com/content/dam/support/en_us/library/ssp/products/connectors/nwrfcsdk/NW_RFC_750_ProgrammingGuide.pdf).
Using an open connection, remote function modules (RFM) can be invoked. More info in [pyrfc documentation](http://sap.github.io/PyRFC/client.html#client-scenariol).
```python
# ABAP variables are mapped to Python variables
result = conn.call('STFC_CONNECTION', REQUTEXT=u'Hello SAP!')
print (result)
{u'ECHOTEXT': u'Hello SAP!',
u'RESPTEXT': u'SAP R/3 Rel. 702 Sysid: ABC Date: 20121001 Time: 134524 Logon_Data: 100/ME/E'}
# ABAP structures are mapped to Python dictionaries
IMPORTSTRUCT = { "RFCFLOAT": 1.23456789, "RFCCHAR1": "A" }
# ABAP tables are mapped to Python lists, of dictionaries representing ABAP tables' rows
IMPORTTABLE = []
result = conn.call("STFC_STRUCTURE", IMPORTSTRUCT=IMPORTSTRUCT, RFCTABLE=IMPORTTABLE)
print result["ECHOSTRUCT"]
{ "RFCFLOAT": 1.23456789, "RFCCHAR1": "A" ...}
print result["RFCTABLE"]
[{ "RFCFLOAT": 1.23456789, "RFCCHAR1": "A" ...}]
```
Finally, the connection is closed automatically when the instance is deleted by the garbage collector. As this may take some time, we may either call the close() method explicitly or use the connection as a context manager:
```python
with Connection(user='me', ...) as conn:
conn.call(...)
# connection automatically closed here
```
Alternatively, connection parameters can be provided as a dictionary:
```python
def get_connection(conn_params):
"""Get connection"""
print 'Connecting ...', conn_params['ashost']
return Connection(**conn_param)
from pyrfc import Connection
abap_system = {
'user' : 'me',
'passwd' : 'secret',
'ashost' : '10.0.0.1',
'saprouter' : '/H/111.22.33.44/S/3299/W/e5ngxs/H/555.66.777.888/H/',
'sysnr' : '00',
'client' : '100',
'trace' : '3', #optional, in case you want to trace
'lang' : 'EN'
}
conn = get_connection(**abap_system)
Connecting ... 10.0.0.1
conn.alive
True
```
See also pyrfc documentation for [Client Scenario](http://sap.github.io/PyRFC/client.html)
### Call Python function from ABAP
```python
# create server for ABAP system ABC
server = Server({"dest": "gateway"}, {"dest": "MME"}, {"port": 8081, "server_log": False})
# expose python function my_stfc_connection as ABAP function STFC_CONNECTION, to be called from ABAP system
server.add_function("STFC_CONNECTION", my_stfc_connection)
# start server
server.start()
# get server attributes
print("Server attributes", server.get_server_attributes())
# stop server
input("Press Enter to stop servers...")
server.stop()
print("Server stoped")
```
See also pyrfc documentation for [Server Scenario](http://sap.github.io/PyRFC/server.html) and server example [source code](https://github.com/SAP/PyRFC/blob/main/examples/server).
## SPJ articles
Highly recommended reading about RFC communication and SAP NW RFC Library, published in the SAP Professional Journal (SPJ)
- [Part I RFC Client Programming](https://wiki.scn.sap.com/wiki/x/zz27Gg)
- [Part II RFC Server Programming](https://wiki.scn.sap.com/wiki/x/9z27Gg)
- [Part III Advanced Topics](https://wiki.scn.sap.com/wiki/x/FD67Gg)
## How to obtain support
If you encounter an issue or have a feature request, you can create a [ticket](https://github.com/SAP/PyRFC/issues).
Check out the [SAP Community](https://community.sap.com/) (search for "pyrfc") and stackoverflow (use the tag [pyrfc](https://stackoverflow.com/questions/tagged/pyrfc)), to discuss code-related problems and questions.
## Contributing
We appreciate contributions from the community to **PyRFC**!
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.
## License
Copyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the [LICENSE file](LICENSES/Apache-2.0.txt).
Raw data
{
"_id": null,
"home_page": "",
"name": "xtest-sapnwrfc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Srdjan Boskovic <srdjan.boskovic@sap.com>",
"keywords": "pyrfc,sap,nwrfc,sapnwrfc,abap",
"author": "SAP SE",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/0e/b5/fb79d88a6ea7f15b04294dbfeb651ddd7cb70ac3a288f1748d70ba1e7d0a/xtest_sapnwrfc-0.0.17.tar.gz",
"platform": null,
"description": "<h1>PyRFC</h1>\n\nAsynchronous, non-blocking [SAP NetWeawer RFC SDK](https://support.sap.com/en/product/connectors/nwrfcsdk.html) bindings for Python.\n\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://pypi.org/project/pyrfc/)\n[](https://pypi.org/project/pyrfc/)\n[](https://pypi.org/project/pyrfc/)\n[](https://pypistats.org/packages/pyrfc)\n[](https://api.reuse.software/info/github.com/SAP/PyRFC)\n[](https://bestpractices.coreinfrastructure.org/projects/4349)\n\n- [Features](#features)\n- [Supported platforms](#supported-platforms)\n- [Requirements](#requirements)\n - [SAP NW RFC SDK 7.50.11](#sap-nw-rfc-sdk-75011)\n - [Docker](#docker)\n - [Windows](#windows)\n - [macOS](#macos)\n- [Download and installation](#download-and-installation)\n- [Getting started](#getting-started)\n - [Call ABAP Function Module from Python](#call-abap-function-module-from-python)\n - [Call Python function from ABAP](#call-python-function-from-abap)\n- [SPJ articles](#spj-articles)\n- [How to obtain support](#how-to-obtain-support)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- Client and Server bindings\n- Automatic conversion between Python and ABAP datatypes\n- Stateless and stateful connections (multiple function calls in the same ABAP session / same context)\n- Sequential and parallel calls, using one or more clients\n- Throughput monitoring\n\n## Supported platforms\n\n- All [platforms supported by SAP NWRFC SDK](https://launchpad.support.sap.com/#/notes/2573790) are supported by build from source installation ([build instructions](http://sap.github.io/PyRFC/build.html))\n\n- In addition, pre-built wheels are provided for Windows, Darwin and Ubuntu Linux, attached to PyRFC GitHub [release](https://github.com/SAP/PyRFC/releases/latest)\n\n- Docker containers: [SAP fundamental-tools/docker](https://github.com/SAP/fundamental-tools/tree/main/docker)\n\n- Linux wheels supported by build from source installation only\n\n- Pre-built [portable Linux wheels](https://www.python.org/dev/peps/pep-0513/)\n - are not supported, neither issues related to portable Linux wheels\n\n - **must not** be distributed with embedded SAP NWRFC SDK binaries, only private use permitted\n\n## Requirements\n\n### SAP NW RFC SDK 7.50.11\n\n- see [SAP Note 3274546](https://launchpad.support.sap.com/#/notes/3274546) for a list of bug fixes and enhancements made with this patch release\n- Using the latest version is recommended as SAP NWRFC SDK is fully backwards compatible, from today S4, down to R/3 release 4.6C.\n- Can be downloaded from SAP Software Download Center of the SAP Support Portal, like described at https://support.sap.com/nwrfcsdk.\n- If you are lacking the required authorization for downloading software from the SAP Service Marketplace, please follow the instructions of [SAP Note 1037575](https://launchpad.support.sap.com/#/notes/1037575) for requesting this authorization.\n\n### Docker\n\n- Docker container examples for Linux, Intel and ARM based Darwin: [SAP/fundamental-tools/docker](https://github.com/SAP/fundamental-tools/tree/main/docker). SAP NWRFC SDK libraries are not included.\n\n### Windows\n\n- [Visual C++ Redistributable Package for Visual Studio 2013](https://www.microsoft.com/en-US/download/details.aspx?id=40784) is required for runtime, see [SAP Note 2573790 - Installation, Support and Availability of the SAP NetWeaver RFC Library 7.50](https://launchpad.support.sap.com/#/notes/2573790)\n\n- Build toolchain for Python 3 requires [Microsoft C++ Build Tools](https://aka.ms/buildtools), the latest version recommended\n\n- Build toolchain for Python 2 requires [Microsoft Visual C++ 9.0](http://aka.ms/vcpython27)\n\n- Due to a [change introduced with Python 3.8 for Windows](https://docs.python.org/3.8/whatsnew/3.8.html#bpo-36085-whatsnew), PATH directories are no longer searched for DLL. The SAP NWRFC SDK lib path is no longer required on PATH, for Python >= 3.8.\n\n### macOS\n\n- Remote paths must be set in SAP NWRFC SDK for macOS: [documentation](http://sap.github.io/PyRFC/install.html#macos)\n\n- When the PyRFC is started for the first time, the popups may come-up for each NWRFC SDK library, to confirm the usage. If SAP NW RFC SDK is installed in admin folder, the app shall be first time started with admin privileges, eg. `sudo -E`\n\n## Download and installation\n\n```shell\npip install pyrfc\n```\n\nCython must be installed upfront because the build from source is standard installation method on Linux.\n\nBuild from source can be requested also on other platforms:\n\n```shell\npip install pyrfc --no-binary :all:\n# or\nPYRFC_BUILD_CYTHON=yes pip install pyrfc --no-binary :all:\n```\n\nAlternative build from source installation:\n\n```shell\ngit clone https://github.com/SAP/PyRFC.git\ncd PyRFC\npython -m pip install .\n# or\npython -m build --wheel --sdist --outdir dist\npip install --upgrade --no-index --find-links=dist pyrfc\n```\n\nSee also the [pyrfc documentation](http://sap.github.io/PyRFC),\ncomplementing _SAP NWRFC SDK_[documentation](https://support.sap.com/nwrfcsdk), especially [SAP NWRFC SDK 7.50 Programming Guide](https://support.sap.com/content/dam/support/en_us/library/ssp/products/connectors/nwrfcsdk/NW_RFC_750_ProgrammingGuide.pdf).\n\n## Getting started\n\n**Note:** The package must be [installed](#download-and-installation) before use.\n\n### Call ABAP Function Module from Python\n\nIn order to call remote enabled ABAP function module (ABAP RFM), first a connection must be opened.\n\n```python\nfrom pyrfc import Connection\nconn = Connection(ashost='10.0.0.1', sysnr='00', client='100', user='me', passwd='secret')\n```\n\nConnection parameters are documented in `sapnwrfc.ini` file, located in the _SAP NWRFC SDK_ `demo` folder. Check also section `4.1.2 Using sapnwrfc.ini` of [SAP NWRFC SDK 7.50 Programming Guide](https://support.sap.com/content/dam/support/en_us/library/ssp/products/connectors/nwrfcsdk/NW_RFC_750_ProgrammingGuide.pdf).\n\nUsing an open connection, remote function modules (RFM) can be invoked. More info in [pyrfc documentation](http://sap.github.io/PyRFC/client.html#client-scenariol).\n\n```python\n# ABAP variables are mapped to Python variables\nresult = conn.call('STFC_CONNECTION', REQUTEXT=u'Hello SAP!')\nprint (result)\n{u'ECHOTEXT': u'Hello SAP!',\n u'RESPTEXT': u'SAP R/3 Rel. 702 Sysid: ABC Date: 20121001 Time: 134524 Logon_Data: 100/ME/E'}\n\n# ABAP structures are mapped to Python dictionaries\nIMPORTSTRUCT = { \"RFCFLOAT\": 1.23456789, \"RFCCHAR1\": \"A\" }\n\n# ABAP tables are mapped to Python lists, of dictionaries representing ABAP tables' rows\nIMPORTTABLE = []\n\nresult = conn.call(\"STFC_STRUCTURE\", IMPORTSTRUCT=IMPORTSTRUCT, RFCTABLE=IMPORTTABLE)\n\nprint result[\"ECHOSTRUCT\"]\n{ \"RFCFLOAT\": 1.23456789, \"RFCCHAR1\": \"A\" ...}\n\nprint result[\"RFCTABLE\"]\n[{ \"RFCFLOAT\": 1.23456789, \"RFCCHAR1\": \"A\" ...}]\n```\n\nFinally, the connection is closed automatically when the instance is deleted by the garbage collector. As this may take some time, we may either call the close() method explicitly or use the connection as a context manager:\n\n```python\nwith Connection(user='me', ...) as conn:\n conn.call(...)\n# connection automatically closed here\n```\n\nAlternatively, connection parameters can be provided as a dictionary:\n\n```python\ndef get_connection(conn_params):\n \"\"\"Get connection\"\"\"\n print 'Connecting ...', conn_params['ashost']\n return Connection(**conn_param)\n\nfrom pyrfc import Connection\n\nabap_system = {\n 'user' : 'me',\n 'passwd' : 'secret',\n 'ashost' : '10.0.0.1',\n 'saprouter' : '/H/111.22.33.44/S/3299/W/e5ngxs/H/555.66.777.888/H/',\n 'sysnr' : '00',\n 'client' : '100',\n 'trace' : '3', #optional, in case you want to trace\n 'lang' : 'EN'\n}\n\nconn = get_connection(**abap_system)\nConnecting ... 10.0.0.1\n\nconn.alive\nTrue\n```\n\nSee also pyrfc documentation for [Client Scenario](http://sap.github.io/PyRFC/client.html)\n\n### Call Python function from ABAP\n\n```python\n# create server for ABAP system ABC\nserver = Server({\"dest\": \"gateway\"}, {\"dest\": \"MME\"}, {\"port\": 8081, \"server_log\": False})\n\n# expose python function my_stfc_connection as ABAP function STFC_CONNECTION, to be called from ABAP system\nserver.add_function(\"STFC_CONNECTION\", my_stfc_connection)\n\n# start server\nserver.start()\n\n# get server attributes\nprint(\"Server attributes\", server.get_server_attributes())\n\n# stop server\ninput(\"Press Enter to stop servers...\")\n\nserver.stop()\nprint(\"Server stoped\")\n```\n\nSee also pyrfc documentation for [Server Scenario](http://sap.github.io/PyRFC/server.html) and server example [source code](https://github.com/SAP/PyRFC/blob/main/examples/server).\n\n## SPJ articles\n\nHighly recommended reading about RFC communication and SAP NW RFC Library, published in the SAP Professional Journal (SPJ)\n\n- [Part I RFC Client Programming](https://wiki.scn.sap.com/wiki/x/zz27Gg)\n\n- [Part II RFC Server Programming](https://wiki.scn.sap.com/wiki/x/9z27Gg)\n\n- [Part III Advanced Topics](https://wiki.scn.sap.com/wiki/x/FD67Gg)\n\n## How to obtain support\n\nIf you encounter an issue or have a feature request, you can create a [ticket](https://github.com/SAP/PyRFC/issues).\n\nCheck out the [SAP Community](https://community.sap.com/) (search for \"pyrfc\") and stackoverflow (use the tag [pyrfc](https://stackoverflow.com/questions/tagged/pyrfc)), to discuss code-related problems and questions.\n\n## Contributing\n\nWe appreciate contributions from the community to **PyRFC**!\nSee [CONTRIBUTING.md](CONTRIBUTING.md) for more details on our philosophy around extending this module.\n\n## License\n\nCopyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the [LICENSE file](LICENSES/Apache-2.0.txt).\n",
"bugtrack_url": null,
"license": "Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License. \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\" \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ",
"summary": "Python bindings for SAP NetWeaver RFC SDK",
"version": "0.0.17",
"split_keywords": [
"pyrfc",
"sap",
"nwrfc",
"sapnwrfc",
"abap"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d16cb7d92e143bf709a1e51cdfeb3533102bef63a79977b280bfd472c8f810b0",
"md5": "db68a1c132946976bc61658435c66258",
"sha256": "e53c6c9e25a53c44bd7870fb241e7c7b8ee9159a0b66b5eaa01d7d81b640bffb"
},
"downloads": -1,
"filename": "xtest_sapnwrfc-0.0.17-cp311-cp311-macosx_13_0_arm64.whl",
"has_sig": false,
"md5_digest": "db68a1c132946976bc61658435c66258",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 227519,
"upload_time": "2023-04-25T10:46:57",
"upload_time_iso_8601": "2023-04-25T10:46:57.204348Z",
"url": "https://files.pythonhosted.org/packages/d1/6c/b7d92e143bf709a1e51cdfeb3533102bef63a79977b280bfd472c8f810b0/xtest_sapnwrfc-0.0.17-cp311-cp311-macosx_13_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0eb5fb79d88a6ea7f15b04294dbfeb651ddd7cb70ac3a288f1748d70ba1e7d0a",
"md5": "10678b61b4450e4b8bfa1a83d9b378ba",
"sha256": "3992b09316b05ef19dffca40c2fecde7b18c6616579b9c054640a1275ddfbb24"
},
"downloads": -1,
"filename": "xtest_sapnwrfc-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "10678b61b4450e4b8bfa1a83d9b378ba",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 284190,
"upload_time": "2023-04-25T10:46:59",
"upload_time_iso_8601": "2023-04-25T10:46:59.111227Z",
"url": "https://files.pythonhosted.org/packages/0e/b5/fb79d88a6ea7f15b04294dbfeb651ddd7cb70ac3a288f1748d70ba1e7d0a/xtest_sapnwrfc-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-25 10:46:59",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "xtest-sapnwrfc"
}
