Agrac | 中文

Another Generic REST API Client

Features

Human interface for calling REST APIs of a web site.

1. Login
2. Session
3. Retry
4. Save URL path for reuse.
5. Pattern reuse.
6. CRUD included.
7. Automatically goto next page.
8. Django REST native support.

Rules：

1. [] for URL path.
2. () for get() params, or update/post/create() data.
3. . operator for json data.

A lot todos.

Examples：

Without Output:

In [1]: from agrac.client import Client

In [2]: c=Client('https://httpbin.org/')

# patch
# curl -X PATCH "https://httpbin.org/patch" -H "accept: application/json"
In [3]: c['patch'].patch()


# post with data
# curl -X POST "https://httpbin.org/post" -H "accept: application/json"
In [4]: c['post'].post(a=12,b=23)



# get
# curl -X GET "https://httpbin.org/get" -H "accept: application/json"
In [5]: c['get'].get()


# path
# curl -X POST "https://httpbin.org/delay/1" -H "accept: application/json"
In [8]: c['/delay/1'].post(a=33) # equal to c['delay']['1'].post(a=33)

# path also can be stored
In [9]: delay = c['/delay']
In [10]: delay[1].post()



# login: HTTP Basic Auth.
# curl -X GET "https://httpbin.org/basic-auth/aaa/bbb" -H "accept: application/json"

In [1]: from agrac.client import Client
In [2]: c=Client('https://httpbin.org/')
In [4]: c.set_auth('aaa','bbb')
In [5]: c["/basic-auth/aaa/bbb"].get()



# login: REST
from agrac.client import Client
c=Client('http://192.168.1.1/')
c.login('admin', 'admin', longin_url='/base/login/)

# auto next page.
for i in c['tags'].iter_pages(page=1,size=10):
    print(i)

With output:

In [1]: from agrac.client import Client

In [2]: c=Client('https://httpbin.org/')

# patch
# curl -X PATCH "https://httpbin.org/patch" -H "accept: application/json"
In [3]: c['patch'].patch()
Out[3]: 
{'args': {},
 'data': '{}',
 'files': {},
 'form': {},
 'headers': {'Accept': '*/*',
  'Accept-Encoding': 'gzip, deflate',
  'Content-Length': '2',
  'Content-Type': 'application/json',
  'Host': 'httpbin.org',
  'User-Agent': 'python-requests/2.25.1',
  'X-Amzn-Trace-Id': 'Root=1-615416db-707c6b6925fdeb3d24cc4333'},
 'json': {},
 'origin': '61.150.12.145',
 'url': 'https://httpbin.org/patch'}


# post with data
# curl -X POST "https://httpbin.org/post" -H "accept: application/json"
In [4]: c['post'].post(a=12,b=23)
Out[4]: 
{'args': {},
 'data': '{"a": 12, "b": 23}',
 'files': {},
 'form': {},
 'headers': {'Accept': '*/*',
  'Accept-Encoding': 'gzip, deflate',
  'Content-Length': '18',
  'Content-Type': 'application/json',
  'Host': 'httpbin.org',
  'User-Agent': 'python-requests/2.25.1',
  'X-Amzn-Trace-Id': 'Root=1-615416b9-789490957c7909413dec9465'},
 'json': {'a': 12, 'b': 23},
 'origin': '61.150.12.145',
 'url': 'https://httpbin.org/post'}

# get
# curl -X GET "https://httpbin.org/get" -H "accept: application/json"
In [5]: c['get'].get()
Out[5]: 
{'args': {},
 'headers': {'Accept': '*/*',
  'Accept-Encoding': 'gzip, deflate',
  'Host': 'httpbin.org',
  'User-Agent': 'python-requests/2.25.1',
  'X-Amzn-Trace-Id': 'Root=1-61541722-3f0a55ab18ab4d8a7ff9eb13'},
 'origin': '61.150.12.145',
 'url': 'https://httpbin.org/get'}


# path
# curl -X POST "https://httpbin.org/delay/1" -H "accept: application/json"
In [8]: c['/delay/1'].post(a=33) # equal to c['delay']['1'].post(a=33)
Out[8]: 
{'args': {},
 'data': '{"a": 33}',
 'files': {},
 'form': {},
 'headers': {'Accept': '*/*',
  'Accept-Encoding': 'gzip, deflate',
  'Content-Length': '9',
  'Content-Type': 'application/json',
  'Host': 'httpbin.org',
  'User-Agent': 'python-requests/2.25.1',
  'X-Amzn-Trace-Id': 'Root=1-6154187b-38ffed93163a8ee9051f3824'},
 'origin': '61.150.12.145',
 'url': 'https://httpbin.org/delay/1'}

# path also can be stored
In [9]: delay = c['/delay']
In [10]: delay[1].post()
Out[10]: 
{'args': {},
 'data': '{}',
 'files': {},
 'form': {},
 'headers': {'Accept': '*/*',
  'Accept-Encoding': 'gzip, deflate',
  'Content-Length': '2',
  'Content-Type': 'application/json',
  'Host': 'httpbin.org',
  'User-Agent': 'python-requests/2.25.1',
  'X-Amzn-Trace-Id': 'Root=1-615418c0-2ecb57be5fe2f2ae5a310790'},
 'origin': '61.150.12.145',
 'url': 'https://httpbin.org/delay/1'}


# login: HTTP Basic Auth.
# curl -X GET "https://httpbin.org/basic-auth/aaa/bbb" -H "accept: application/json"

In [1]: from agrac.client import Client

In [2]: c=Client('https://httpbin.org/')

In [4]: c.set_auth('aaa','bbb')
In [5]: c["/basic-auth/aaa/bbb"].get()

Out[5]: {'authenticated': True, 'user': 'aaa'}

# login: REST
from agrac.client import Client
c=Client('http://192.168.1.1/')
c.login('admin', 'admin', longin_url='/base/login/)

# auto next page.
for i in c['tags'].iter_pages(page=1,size=10):
    print(i)