# paypalhttp_python

**Repository Path**: mirrors_paypal/paypalhttp_python

## Basic Information

- **Project Name**: paypalhttp_python
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-18
- **Last Updated**: 2026-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Deprecation Notice:
This SDK is deprecated; you can continue to use it, but no new features or support requests will be accepted. An integration with [the new Server SDK](https://github.com/paypal/PayPal-Server-SDKs) is recommended. Review the [docs](https://developer.paypal.com/serversdk/http/getting-started/how-to-get-started/) for details.

## PayPal HttpClient 
PayPalHttp is a generic HTTP Client.

In it's simplest form, an [`HttpClient`](paypalhttp/http_client.py) exposes an `#execute` method which takes an HTTP request, executes it against the domain described in an `Environment`, and returns an `HttpResponse`. It throws an Error, and potentially an HttpError, if anything goes wrong during execution.

### Environment

An [`Environment`](paypalhttp/environment.py) describes a domain that hosts a REST API, against which an `HttpClient` will make requests. `Environment` is a simple class that contains one property, `base_url`.

```py
env = Environment("https://example.com")
```

### Requests

HTTP request objects contain all the information needed to make an HTTP request against the REST API. Specifically, one request object describes a path, a verb, any path/query/form parameters, headers, attached files for upload, and body data.

### Responses

[`HttpResponse`](paypalhttp/http_response.py)s contain information returned by a server in response to a request as described above. They contain a `status_code`, `headers`, and a `result`, which represents any data returned by the server.

```py
class GenericRequest():
  def __init__(self):
    self.path = "/path/to/resource"
    self.verb = "GET"
    self.headers = {
      "X-Custom-Header": "custom value"
    }

resp = client.execute(GenericRequest())
```

### Injectors

Injectors are functions that can be used for executing arbitrary pre-flight logic, such as modifying a request or logging data. Injectors are attached to an `HttpClient` using the `#add_injector` method. They may take the form of a class that implements `__call__`, a function reference, or a lambda expression.

The HttpClient executes its `Injector`s in a first-in, first-out order, before each request.

```py
client = HttpClient(env)

class HeadersInjector():
  def __call__(req):
    req.headers["Request-Id"] = "abcd"

client.add_injector(HeadersInjector())

def inject_query_param(req):
  req.path += "?query=param"

client.add_injector(inject_query_param)

client.add_injector(lambda req: print req)

...
```

### Error Handling

`HttpClient#execute` may raise an `IOError` if something went wrong during the course of execution. If the server returned a non-200 response, this execption will be an instance of [`HttpError`](paypalhttp/http_error.py) that will contain a status code and headers you can use for debugging. 

```py
try:
  resp = client.execute(req)
  status_code = resp.status_code
  headers = resp.headers
  response_data = resp.result
except HttpError as err:
  # Inspect this exception for details
  status_code = err.status_code
  headers = err.headers
  message = str(err)
except IOError as ioe:
  # Something else went wrong
  print ioe
```

### Serializer
(De)Serialization of request and response data is done by instances of [`Encoder`](paypalhttp/encoder.py). PayPalHttp currently supports `json` encoding out of the box.

## License
PayPalHttp-Python is open source and available under the MIT license. See the [LICENSE](./LICENSE) file for more info.

## Contributing
Pull requests and issues are welcome. Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for more details.