![code included in
the demo
6
'''Funny cat names in hug'''
import hug
cats = []
#starts up on server launch
@hug.startup()
def init(api):
cats.extend(['fluffy','bubba','cuddles','meowly'])
#default arguments make them not required
@hug.get()
def hello(name :hug.types.text='stranger'):
'''Greets you on /v1/hello'''
return 'Hi there ' + name + '!'
#supports all http methods
@hug.post('/cats')
def add_cat(name :hug.types.text):
'''Add cat name to the list'''
cats.append(name)
return {'result':'ok'}
#easy versioning
@hug.post('/cats', versions=2)
def add_cat(name :hug.types.text):
'''Add cat name to the list'''
cats.append(name)
return {'id':len(cats)-1}
#supports URI params
@hug.get('/cats/{id}')
def get_cat(id :hug.types.number):
'''Get cat name with specified id'''
return cats[id]
#provide examples for easy launch from
documentation
@hug.get('/cats', examples='length=3')
def get_cats(length :hug.types.number=None):
'''Get funny cat names'''
if length:
return cats[:length]
else:
return cats](https://image.slidesharecdn.com/hugpresentationforandroidtechtalks-160922205901/85/Hug-presentation-for-android-tech-talks-14-6-320.jpg)
![types
● used for validation or
simple mutation of
parameters
● work through function
annotations
● various different types
available and custom
types are supported
9
@hug.type(extend=hug.types.text)
def htmlcolor(value):
'''HTML color code'''
pattern = re.compile('#[0-9a-fA-F]{6}')
m = pattern.match(value)
if m:
return m.group()
else:
raise ValueError('Value is not a html color code')
@hug.post('/lamp/{id}/changecolor')
def change_color(id :hug.types.number, color :htmlcolor()):
return {'id':id,'color':color}
@hug.type(extend=htmlcolor)
def torgbtuple(value):
'''Color tuple'''
value = value.lstrip('#')
return tuple(int(value[i:i + 2],16) for i in range(0, 6, 2))
@hug.post('/color')
def get_rgb_touple(color :torgbtuple()):
return {'red':color[0],'green':color[1],'blue':color[2]}](https://image.slidesharecdn.com/hugpresentationforandroidtechtalks-160922205901/85/Hug-presentation-for-android-tech-talks-14-9-320.jpg)
Hug presentation for android tech talks #14
- 1. the easiest API for your apps with hug 1
- 2. Mocking services ● static (no logic allowed) ● limited ● essential functions are for paid users only ● no full control over API 2
- 3. hug ● written by Timothy Crosley ● currently on version 2.1.2 ● runs on python3 ● built on top of Falcon ● magic done once ● feature-filled ● as easy as writing definition 3 source: http://www.hug.rest
- 4. bare minimum 4 # server.py import hug @hug.get() def hello(): return 'Hi there!' $ hug -f server.py run it with
- 5. live demo 5
- 6. code included in the demo 6 '''Funny cat names in hug''' import hug cats = [] #starts up on server launch @hug.startup() def init(api): cats.extend(['fluffy','bubba','cuddles','meowly']) #default arguments make them not required @hug.get() def hello(name :hug.types.text='stranger'): '''Greets you on /v1/hello''' return 'Hi there ' + name + '!' #supports all http methods @hug.post('/cats') def add_cat(name :hug.types.text): '''Add cat name to the list''' cats.append(name) return {'result':'ok'} #easy versioning @hug.post('/cats', versions=2) def add_cat(name :hug.types.text): '''Add cat name to the list''' cats.append(name) return {'id':len(cats)-1} #supports URI params @hug.get('/cats/{id}') def get_cat(id :hug.types.number): '''Get cat name with specified id''' return cats[id] #provide examples for easy launch from documentation @hug.get('/cats', examples='length=3') def get_cats(length :hug.types.number=None): '''Get funny cat names''' if length: return cats[:length] else: return cats
- 7. features supported by hug 7
- 8. types ● used for validation or simple mutation of parameters ● work through function annotations ● various different types available and custom types are supported 8 ★ primitive types(text, number, boolean etc.) ★ delimited list ★ multiple types at once ★ more than, less than, length ★ cut off
- 9. types ● used for validation or simple mutation of parameters ● work through function annotations ● various different types available and custom types are supported 9 @hug.type(extend=hug.types.text) def htmlcolor(value): '''HTML color code''' pattern = re.compile('#[0-9a-fA-F]{6}') m = pattern.match(value) if m: return m.group() else: raise ValueError('Value is not a html color code') @hug.post('/lamp/{id}/changecolor') def change_color(id :hug.types.number, color :htmlcolor()): return {'id':id,'color':color} @hug.type(extend=htmlcolor) def torgbtuple(value): '''Color tuple''' value = value.lstrip('#') return tuple(int(value[i:i + 2],16) for i in range(0, 6, 2)) @hug.post('/color') def get_rgb_touple(color :torgbtuple()): return {'red':color[0],'green':color[1],'blue':color[2]}
- 10. directives ● work as prefixed arguments or function annotations ● can provide pretty much everything without tying you to any interface ● custom directives supported 10 ★ session ★ user ★ documentation ★ timer ★ api version
- 11. directives ● work as prefixed arguments or function annotations ● can provide pretty much everything without tying you to any interface ● custom directives supported 11 @hug.directive() def session(context_name='session', request=None, **kwargs): """Returns the session associated with the current request""" return request and request.context.get(context_name, None) or None #function annotation @hug.get() def my_endpoint(session: hug.directives.session): session #prefixed with hug_ @hug.get() def my_endpoint(hug_session): session
- 12. routing ● used for mapping external interaction to internal functions ● works as function decorators ● can be used separately from function/object ● supports chaining 12 ★ urls ★ examples ★ response headers ★ status code ★ versions ★ response on invalid request
- 13. routing ● used for mapping external interaction to internal functions ● works as function decorators ● can be used separately from function/object ● supports chaining 13 # external.py import hug import internal router = hug.route.API(__name__) router.get('/home')(internal.root) # internal.py def root(): return 'Welcome home!'
- 14. routing ● used for mapping external interaction to internal functions ● works as function decorators ● can be used separately from function/object ● supports chaining 14 import hug api = hug.get(on_invalid=hug.redirect.not_found) @api.urls('/do-math', examples='number_1=1&number_2=2') def math(number_1: hug.types.number, number_2: hug.types.number): return number_1 + number_2 @api def happy_birthday(name, age: hug.types.number): """Says happy birthday to a user""" return "Happy {age} Birthday {name}!".format(**locals())
- 15. but wait! There’s more: 15 ● different output formats (image, video, file streams) ● extensions through PyPI ● authentication ● command line interface ● easy testing
- 16. other python libraries I used ● shelve - data persistence ● warlock - model with validation ● jsonschema - model description used by warlock 16
- 17. “Hug is the best thing since sliced bread” - Abraham Lincoln 17