From e15e60360857070ea2095b9d27c7f2ec097ddd2d Mon Sep 17 00:00:00 2001 From: Santiago Lo Coco Date: Fri, 27 Oct 2023 12:19:13 -0300 Subject: [PATCH] Add initial files --- .gitignore | 30 ++++++++++++++ LICENSE.md | 9 +++++ README.md | 85 ++++++++++++++++++++++++++++++++++++++++ pyproject.toml | 42 ++++++++++++++++++++ src/asyncreq/__init__.py | 1 + src/asyncreq/network.py | 41 +++++++++++++++++++ 6 files changed, 208 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE.md create mode 100644 README.md create mode 100644 pyproject.toml create mode 100644 src/asyncreq/__init__.py create mode 100644 src/asyncreq/network.py diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9be494c --- /dev/null +++ b/.gitignore @@ -0,0 +1,30 @@ +.idea +.ipynb_checkpoints +.mypy_cache +.vscode +__pycache__ +.pytest_cache +htmlcov +dist +site +.coverage +coverage.xml +.netlify +test.db +log.txt +Pipfile.lock +env3.* +env +docs_build +site_build +venv +docs.zip +archive.zip + +# vim temporary files +*~ +.*.sw? +.cache + +# macOS +.DS_Store diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..00a237a --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2023 Santiago Lo Coco + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..c80a4cc --- /dev/null +++ b/README.md @@ -0,0 +1,85 @@ +# asyncreq + +`asyncreq` is a lightweight Python library for making asynchronous HTTP requests using `aiohttp`. This library provides two convenient methods for interacting with RESTful APIs in an asynchronous manner. + +## Installation + +To install the library, use the following pip command: + +```bash +pip install asyncreq +``` + +## Usage + +### `make_request` + +The `make_request` method allows you to make asynchronous HTTP requests with flexible options. Here's an example of how to use it: + +```python +from asyncreq import make_request + +async def example_usage(): + url = "https://api.example.com/resource" + method = "GET" + headers = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"} + + try: + response_data, status_code, response_headers = await make_request( + url=url, + method=method, + headers=headers, + # Add other optional parameters as needed + ) + print(f"Response Data: {response_data}") + print(f"Status Code: {status_code}") + print(f"Response Headers: {response_headers}") + except Exception as e: + print(f"An error occurred: {e}") + +# Run the example +example_usage() +``` + +### `request` + +The `request` method is a simplified wrapper around `make_request` with added error handling. It raises appropriate exceptions for common HTTP-related errors: + +```python +from your_library_name import request, HTTPException + +async def example_usage(): + url = "https://api.example.com/resource" + method = "GET" + headers = {"Authorization": "Bearer YOUR_ACCESS_TOKEN"} + + try: + response_data, status_code, response_headers = await request( + url=url, + method=method, + headers=headers, + # Add other optional parameters as needed + ) + print(f"Response Data: {response_data}") + print(f"Status Code: {status_code}") + print(f"Response Headers: {response_headers}") + except HTTPException as e: + print(f"An HTTP error occurred: {e}") + +# Run the example +example_usage() +``` + +Note: If you are running the code from an async function, make sure to use `await` as demonstrated in the examples above. If you are running the code outside of an async function, remove the `await` keyword. + +## Dependencies + +- [aiohttp](https://docs.aiohttp.org/): Asynchronous HTTP client/server framework. + +## Contributing + +If you find any issues or have suggestions for improvements, please feel free to open an issue or create a pull request on the [Git repository](https://git.slc.ar/slococo/asyncreq). + +## License + +This project is licensed under the MIT license. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..8c8033a --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,42 @@ +[build-system] +requires = ["hatchling >= 1.13.0"] +build-backend = "hatchling.build" + +[project] +name = "asyncreq" +version = "0.0.3" +description = "A lightweight library for making asynchronous HTTP requests." +readme = "README.md" +requires-python = ">=3.8" +license = "MIT" +authors = [ + { name = "Santiago Lo Coco", email = "mail@slococo.com.ar" }, +] +classifiers = [ + "Intended Audience :: Information Technology", + "Intended Audience :: System Administrators", + "Operating System :: OS Independent", + "Programming Language :: Python :: 3", + "Programming Language :: Python", + "Topic :: Internet", + "Topic :: Software Development :: Libraries :: Python Modules", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development", + "Typing :: Typed", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", +] +dependencies = [ + "fastapi>=0.103.2", + "aiohttp>=3.8.6" +] + +[project.urls] +Homepage = "https://git.slc.ar/slococo/asyncrequest" +Repository = "https://git.slc.ar/slococo/asyncrequest" + diff --git a/src/asyncreq/__init__.py b/src/asyncreq/__init__.py new file mode 100644 index 0000000..e26568b --- /dev/null +++ b/src/asyncreq/__init__.py @@ -0,0 +1 @@ +from .network import make_request, request diff --git a/src/asyncreq/network.py b/src/asyncreq/network.py new file mode 100644 index 0000000..a5918f7 --- /dev/null +++ b/src/asyncreq/network.py @@ -0,0 +1,41 @@ +from typing import Optional + +import aiohttp +import async_timeout +from aiohttp import ClientConnectorError, ContentTypeError, JsonPayload +from fastapi import HTTPException, Response + + +async def make_request( + url: str, + method: str, + headers: dict = None, + query: Optional[dict] = None, + data: str = None, + json: JsonPayload = None, + timeout: int = 60, +): + async with async_timeout.timeout(delay=timeout): + async with aiohttp.ClientSession(headers=headers) as session: + async with session.request( + method=method, url=url, params=query, data=data, json=json + ) as response: + if response.status == 204: + response_json = Response(status_code=204) + else: + response_json = await response.json() + decoded_json = response_json + return decoded_json, response.status, response.headers + + +async def request(url, method, headers=None, data=None, json=None, query=None): + try: + (x, y, z) = await make_request( + url=url, method=method, headers=headers, data=data, json=json, query=query + ) + except ClientConnectorError: + raise HTTPException(status_code=503, detail="Service is unavailable.") + except ContentTypeError: + raise HTTPException(status_code=500, detail="Service error.") + return x, y, z +