A simple library for read/write access to OData services.
- Supports OData version 4.0
- Requires JSON format support from the service
- Should work on both Python 2.x and 3.x
Available on readthedocs.org
- requests >= 2.0
- python-dateutil
- rich >= 13.3.1
Reading data from the Northwind service.
import requests
from datetime import datetime
# you can only import this on the second run, the first run will create the package
# import generated
from odata import ODataService
session = requests.Session()
url = 'http://services.odata.org/V4/Northwind/Northwind.svc/'
service = ODataService(
url="http://services.odata.org/V4/Northwind/Northwind.svc/",
session=session,
base=generated.northwind.ReflectionBase,
reflect_entities=True,
reflect_output_package="generated.northwind")
OrderDetails = generated.northwind.Order_Details
q = service.query(generated.northwind.Customers)
q = q.filter(generated.northwind.Customers.ContactTitle.startswith('Sales'))
q = q.filter(generated.northwind.Customers.PostalCode == '68306')
data = q.first()
query = service.query(OrderDetails)
values = query.all()
values = query \
.filter((OrderDetails.Order.Employee.HomePhone.contains("555")) | (OrderDetails.Order.Employee.City == "London")) \
.filter(OrderDetails.Order.Employee.FirstName.lacks("Steven")) \
.filter(OrderDetails.Order.OrderDate >= datetime(year=1990, month=5, day=1, hour=10, minute=10, second=59, tzinfo=pytz.UTC))\
.expand(OrderDetails.Order, OrderDetails.Order.Employee) \
.order_by(OrderDetails.Order.ShipCountry.asc()) \
.limit(10) \
.all()
for order_details in values:
print(f"Order {order_details.OrderID}")
service.values(order_details)
service.values(order_details.Order)
service.values(order_details.Order.Employee)
import datetime
Order = Service.entities['Order']
Employee = Service.entities['Employee']
empl = Service.query(Employee).first()
query = Service.query(Order)
query = query.filter(Order.ShipCity == 'Berlin')
for order in query:
order.ShippedDate = datetime.datetime.utcnow()
order.Employee = empl
Service.save(order)
OData V4 example with Enums.
import logging
import requests
import rich
# comment on first run so you get the generated package
import generated.trippin
from odata import ODataService
requests.packages.urllib3.disable_warnings()
def test_trippin(console):
proxy = {'http': '', 'https': ''}
session = requests.Session()
session.trust_env = False
session.verify = False
session.proxies.update(proxy)
service = ODataService(
url="https://services.odata.org/v4/TripPinServiceRW",
session=session,
#base=generated.trippin.ReflectionBase, # comment on first run
#reflect_entities=True,
reflect_output_package="generated.trippin")
People = generated.trippin.People
q = service.query(People)
values = q.all()
for value in values:
console.rule(f"People {value.FirstName} {value.LastName}")
service.values(value)
if __name__ == "__main__":
logging.basicConfig(level="DEBUG")
console = rich.console.Console()
test_trippin(console)
Writing changes. Note that the real Northwind service is read-only and the data modifications do not work against it.