Mercurial Repository: p/roundup/code: roundup/rest.py comparison

comparison roundup/rest.py @ 8188:e5362f8e1808

chore(ruff): rename input and id parms/vars - don't shadow builtin Changed input parm to input_payload and id param to node_id for etag context. Changed var/param id to item_id. Change var id to working_id. Trying to clear a lot of ruff warnings as client.py and rest.py will be getting some work done on them and I want to reduce erros so I can see errors in newer code more easily.

author	John Rouillard <rouilj@ieee.org>
date	Wed, 11 Dec 2024 13:04:34 -0500
parents	d02ce1d14acd
children	569aff540a21

comparison

equal deleted inserted replaced

-:5c506c778893
+:e5362f8e1808
 f.openapi_doc = d
 return f
 return wrapper
-def calculate_etag(node, key, classname="Missing", id="0",
+def calculate_etag(node, key, classname="Missing", node_id="0",
 repr_format="json"):
 '''given a hyperdb node generate a hashed representation of it to be
 used as an etag.
 This code needs a __repr__ function in the Password class. This
 calculate the etag.
 Note that repr() is chosen for the node rather than str() since
 repr is meant to be an unambiguous representation.
-classname and id are used for logging only.
+classname and node_id are used for logging only.
 '''
 items = node.items(protected=True)  # include every item
 etag = hmac.new(bs2b(key), bs2b(repr_format +
 repr(sorted(items))), md5).hexdigest()
-logger.debug("object=%s%s; tag=%s; repr=%s", classname, id,
+logger.debug("object=%s%s; tag=%s; repr=%s", classname, node_id,
 etag, repr(node.items(protected=True)))
 # Quotes are part of ETag spec, normal headers don't have quotes
 return '"%s"' % etag
-def check_etag(node, key, etags, classname="Missing", id="0",
+def check_etag(node, key, etags, classname="Missing", node_id="0",
 repr_format="json"):
 '''Take a list of etags and compare to the etag for the given node.
 Iterate over all supplied etags,
 If a tag fails to match, return False.
 If all etags are None, return False.
 '''
 have_etag_match = False
-node_etag = calculate_etag(node, key, classname, id,
+node_etag = calculate_etag(node, key, classname, node_id,
 repr_format=repr_format)
 for etag in etags:
 # etag includes doublequotes around tag:
 #   '"a46a5572190e4fad63958c135f3746fa"'
 return True
 else:
 return False
-def obtain_etags(headers, input):
+def obtain_etags(headers, input_payload):
-'''Get ETags value from headers or payload data'''
+'''Get ETags value from headers or payload data
+Only supports one etag value not list.
+'''
 etags = []
-if '@etag' in input:
+if '@etag' in input_payload:
-etags.append(input['@etag'].value)
+etags.append(input_payload['@etag'].value)
 etags.append(headers.get("If-Match", None))
 return etags
 def parse_accept_header(accept):
 cls.__route_map[pattern] = rule_route
 return func
 return decorator
 @classmethod
-def execute(cls, instance, path, method, input):
+def execute(cls, instance, path, method, input_payload):
-# format the input, note that we may not lowercase the path
+# format the input_payload, note that we may not lowercase the path
 # here, URL parameters are case-sensitive
 path = path.strip('/')
 if path == 'rest':
 # allow handler to be called for /rest/
 path = 'rest/'
 list_vars = func_obj['vars']
 func = func_obj['func']
 # zip the varlist into a dictionary, and pass it to the caller
 args = dict(zip(list_vars, match_obj.groups()))
-args['input'] = input
+args['input'] = input_payload
 return func(instance, **args)
 raise NotFound('Nothing matches the given URI')
 class RestfulInstance(object):
 else:
 raise UsageError('PATCH Operation %s is not allowed' % op)
 return result
-def raise_if_no_etag(self, class_name, item_id, input, repr_format="json"):
+def raise_if_no_etag(self, class_name, item_id, input_payload,
+repr_format="json"):
 class_obj = self.db.getclass(class_name)
 if not check_etag(class_obj.getnode(item_id),
 self.db.config.WEB_SECRET_KEY,
-obtain_etags(self.client.request.headers, input),
+obtain_etags(self.client.request.headers,
-class_name,
+input_payload), class_name, item_id,
-item_id, repr_format=repr_format):
+repr_format=repr_format):
 raise PreconditionFailed(
 "If-Match is missing or does not match."
 " Retrieve asset and retry modification if valid.")
 def format_item(self, node, item_id, props=None, verbose=1):
 result = {}
 try:
 # pn = propname
 for pn in sorted(props):
 ok = False
-id = item_id
+working_id = item_id
 nd = node
 cn = class_name
 for p in pn.split('.'):
 if not self.db.security.hasPermission(
-'View', uid, cn, p, id
+'View', uid, cn, p, working_id
 ):
 break
 cl = self.db.getclass(cn)
-nd = cl.getnode(id)
+nd = cl.getnode(working_id)
-id = v = getattr(nd, p)
+working_id = v = getattr(nd, p)
 # Handle transitive properties where something on
 # the road is None (empty Link property)
-if id is None:
+if working_id is None:
 prop = None
 ok = True
 break
 prop = cl.getprops(protected=True)[p]
 cn = getattr(prop, 'classname', None)
 linkcls = self.db.getclass(prop.classname)
 cp = '%s/%s/' % (self.data_path, prop.classname)
 if verbose and v:
 if isinstance(v, type([])):
 r = []
-for id in v:
+for working_id in v:
-d = dict(id=id, link=cp + id)
+d = dict(id=working_id, link=cp + working_id)
 if verbose > 1:
 label = linkcls.labelprop()
-d[label] = linkcls.get(id, label)
+d[label] = linkcls.get(working_id, label)
 r.append(d)
 result[pn] = r
 else:
 result[pn] = dict(id=v, link=cp + v)
 if verbose > 1:
 return result
 @Routing.route("/data/<:class_name>", 'GET')
 @_data_decorator
-def get_collection(self, class_name, input):
+def get_collection(self, class_name, input_payload):
 """GET resource from class URI.
 This function returns only items have View permission
 class_name should be valid already
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 list: list of reference item in the class
 id: id of the object
 }
 verbose = 1
 display_props = set()
 sort = []
 group = []
-for form_field in input.value:
+for form_field in input_payload.value:
 key = form_field.name
 value = form_field.value
 if key.startswith("@page_"):  # serve the paging purpose
 key = key[6:]
 value = int(value)
 result['@links'][rel].append({
 'rel': rel,
 'uri': "%s/%s?@page_index=%s&" % (self.data_path,
 class_name, index) +
 '&'.join(["%s=%s" % (field.name, field.value)
-for field in input.value
+for field in input_payload.value
 if field.name != "@page_index"])})
 result['@total_size'] = total_len
 self.client.setHeader("X-Count-Total", str(total_len))
 self.client.setHeader("Allow", "OPTIONS, GET, POST")
 return 200, result
 @Routing.route("/data/user/roles", 'GET')
 @_data_decorator
-def get_roles(self, input):
+def get_roles(self, input_payload):
 """Return all defined roles for users with Admin role.
 The User class property roles is a string but simulate
 it as a MultiLink to an actual Roles class.
 """
 if not self.client.db.user.has_role(self.client.db.getuid(), "Admin"):
 [{"id": rolename,"name": rolename}
 for rolename in list(self.db.security.role.keys())]}
 @Routing.route("/data/<:class_name>/<:item_id>", 'GET')
 @_data_decorator
-def get_element(self, class_name, item_id, input):
+def get_element(self, class_name, item_id, input_payload):
 """GET resource from object URI.
 This function returns only properties have View permission
 class_name and item_id should be valid already
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
 or (if the class has a key property) this can also be
 the key name, e.g. class_name = status, item_id = 'open'
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict: a dictionary represents the object
 id: id of the object
 etag = calculate_etag(node, self.db.config.WEB_SECRET_KEY,
 class_name, itemid, repr_format="json")
 props = None
 protected = False
 verbose = 1
-for form_field in input.value:
+for form_field in input_payload.value:
 key = form_field.name
 value = form_field.value
 if key == "@fields" or key == "@attrs":
 if props is None:
 props = set()
 self.client.setHeader("ETag", etag)
 return 200, result
 @Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'GET')
 @_data_decorator
-def get_attribute(self, class_name, item_id, attr_name, input):
+def get_attribute(self, class_name, item_id, attr_name, input_payload):
 """GET resource from attribute URI.
 This function returns only attribute has View permission
 class_name should be valid already
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
 attr_name (string): attribute of the resource (Ex: title, nosy)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 list: a dictionary represents the attribute
 id: id of the object
 self.client.setHeader("ETag", etag)
 return 200, result
 @Routing.route("/data/<:class_name>", 'POST')
 @_data_decorator
-def post_collection(self, class_name, input):
+def post_collection(self, class_name, input_payload):
 """POST a new object to a class
 If the item is successfully created, the "Location" header will also
 contain the link to the created object
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 201 (Created)
 dict: a reference item to the created object
 id: id of the object
 link: path to the object
 """
-return self.post_collection_inner(class_name, input)
+return self.post_collection_inner(class_name, input_payload)
 @Routing.route("/data/<:class_name>/@poe", 'POST')
 @_data_decorator
-def get_post_once_exactly(self, class_name, input):
+def get_post_once_exactly(self, class_name, input_payload):
 """Get the Post Once Exactly token to create a new instance of class
 See https://tools.ietf.org/html/draft-nottingham-http-poe-00"""
 otks = self.db.Otk
 poe_key = otks.getUniqueKey()
 try:
-lifetime = int(input['lifetime'].value)
+lifetime = int(input_payload['lifetime'].value)
 except KeyError:
 lifetime = 30 * 60  # 30 minutes
 except ValueError:
-raise UsageError("Value 'lifetime' must be an integer specify lifetime in seconds. Got %s." % input['lifetime'].value)
+raise UsageError("Value 'lifetime' must be an integer specify lifetime in seconds. Got %s." % input_payload['lifetime'].value)
 if lifetime > 3600 or lifetime < 1:
-raise UsageError("Value 'lifetime' must be between 1 second and 1 hour (3600 seconds). Got %s." % input['lifetime'].value)
+raise UsageError("Value 'lifetime' must be between 1 second and 1 hour (3600 seconds). Got %s." % input_payload['lifetime'].value)
 try:
 # if generic tag exists, we don't care about the value
-is_generic = input['generic']
+is_generic = input_payload['generic']
 # we generate a generic POE token
 is_generic = True
 except KeyError:
 is_generic = False
 (self.data_path, class_name, poe_key),
 'expires': ts + (60 * 60 * 24 * 7)}
 @Routing.route("/data/<:class_name>/@poe/<:post_token>", 'POST')
 @_data_decorator
-def post_once_exactly_collection(self, class_name, post_token, input):
+def post_once_exactly_collection(self, class_name, post_token, input_payload):
 """Post exactly one to the resource named by class_name"""
 otks = self.db.Otk
 # remove expired keys so we don't use an expired key
 otks.clean()
 if cn != class_name and cn is not None:
 raise UsageError("POE token '%s' not valid for %s, was generated for class %s" % (post_token, class_name, cn))
 # handle this as though they POSTed to /rest/data/class
-return self.post_collection_inner(class_name, input)
+return self.post_collection_inner(class_name, input_payload)
-def post_collection_inner(self, class_name, input):
+def post_collection_inner(self, class_name, input_payload):
 if class_name not in self.db.classes:
 raise NotFound('Class %s not found' % class_name)
 if not self.db.security.hasPermission(
 'Create', self.db.getuid(), class_name
 ):
 raise Unauthorised('Permission to create %s denied' % class_name)
 class_obj = self.db.getclass(class_name)
 # convert types
-props = self.props_from_args(class_obj, input.value)
+props = self.props_from_args(class_obj, input_payload.value)
 # check for the key property
 key = class_obj.getkey()
 if key and key not in props:
 raise UsageError("Must provide the '%s' property." % key)
 }
 return 201, result
 @Routing.route("/data/<:class_name>/<:item_id>", 'PUT')
 @_data_decorator
-def put_element(self, class_name, item_id, input):
+def put_element(self, class_name, item_id, input_payload):
 """PUT a new content to an object
 Replace the content of the existing object
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict: a dictionary represents the modified object
 id: id of the object
 """
 if class_name not in self.db.classes:
 raise NotFound('Class %s not found' % class_name)
 class_obj = self.db.getclass(class_name)
-props = self.props_from_args(class_obj, input.value, item_id)
+props = self.props_from_args(class_obj, input_payload.value, item_id)
 for p in props:
 if not self.db.security.hasPermission(
 'Edit', self.db.getuid(), class_name, p, item_id
 ):
 raise Unauthorised(
 'Permission to edit %s of %s%s denied' %
 (p, class_name, item_id)
 )
 try:
-self.raise_if_no_etag(class_name, item_id, input)
+self.raise_if_no_etag(class_name, item_id, input_payload)
 result = class_obj.set(item_id, **props)
 self.db.commit()
 except (TypeError, IndexError, ValueError) as message:
 raise ValueError(message)
 except KeyError as message:
 }
 return 200, result
 @Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'PUT')
 @_data_decorator
-def put_attribute(self, class_name, item_id, attr_name, input):
+def put_attribute(self, class_name, item_id, attr_name, input_payload):
 """PUT an attribute to an object
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
 attr_name (string): attribute of the resource (Ex: title, nosy)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict:a dictionary represents the modified object
 id: id of the object
 (class_name, item_id, attr_name)
 )
 class_obj = self.db.getclass(class_name)
 props = {
 attr_name: self.prop_from_arg(
-class_obj, attr_name, input['data'].value, item_id
+class_obj, attr_name, input_payload['data'].value, item_id
 )
 }
 try:
-self.raise_if_no_etag(class_name, item_id, input)
+self.raise_if_no_etag(class_name, item_id, input_payload)
 result = class_obj.set(item_id, **props)
 self.db.commit()
 except (TypeError, IndexError, ValueError) as message:
 raise ValueError(message)
 except KeyError as message:
 return 200, result
 @Routing.route("/data/<:class_name>", 'DELETE')
 @_data_decorator
-def delete_collection(self, class_name, input):
+def delete_collection(self, class_name, input_payload):
 """DELETE (retire) all objects in a class
 There is currently no use-case, so this is disabled and
 always returns Unauthorised.
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict:
 status (string): 'ok'
 return 200, result
 '''
 @Routing.route("/data/<:class_name>/<:item_id>", 'DELETE')
 @_data_decorator
-def delete_element(self, class_name, item_id, input):
+def delete_element(self, class_name, item_id, input_payload):
 """DELETE (retire) an object in a class
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict:
 status (string): 'ok'
 ):
 raise Unauthorised(
 'Permission to retire %s %s denied' % (class_name, item_id)
 )
-self.raise_if_no_etag(class_name, item_id, input)
+self.raise_if_no_etag(class_name, item_id, input_payload)
 class_obj.retire(item_id)
 self.db.commit()
 result = {
 'status': 'ok'
 }
 return 200, result
 @Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'DELETE')
 @_data_decorator
-def delete_attribute(self, class_name, item_id, attr_name, input):
+def delete_attribute(self, class_name, item_id, attr_name, input_payload):
 """DELETE an attribute in a object by setting it to None or empty
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
 attr_name (string): attribute of the resource (Ex: title, nosy)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict:
 status (string): 'ok'
 props[attr_name] = []
 else:
 props[attr_name] = None
 try:
-self.raise_if_no_etag(class_name, item_id, input)
+self.raise_if_no_etag(class_name, item_id, input_payload)
 class_obj.set(item_id, **props)
 self.db.commit()
 except (TypeError, IndexError, ValueError) as message:
 raise ValueError(message)
 except KeyError as message:
 return 200, result
 @Routing.route("/data/<:class_name>/<:item_id>", 'PATCH')
 @_data_decorator
-def patch_element(self, class_name, item_id, input):
+def patch_element(self, class_name, item_id, input_payload):
 """PATCH an object
 Patch an element using 3 operators
 ADD : Append new value to the object's attribute
 REPLACE: Replace object's attribute
 REMOVE: Clear object's attribute
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict: a dictionary represents the modified object
 id: id of the object
 the object
 """
 if class_name not in self.db.classes:
 raise NotFound('Class %s not found' % class_name)
 try:
-op = input['@op'].value.lower()
+op = input_payload['@op'].value.lower()
 except KeyError:
 op = self.__default_patch_op
 class_obj = self.db.getclass(class_name)
-self.raise_if_no_etag(class_name, item_id, input)
+self.raise_if_no_etag(class_name, item_id, input_payload)
 # if patch operation is action, call the action handler
 action_args = [class_name + item_id]
 if op == 'action':
 # extract action_name and action_args from form fields
 name = None
-for form_field in input.value:
+for form_field in input_payload.value:
 key = form_field.name
 value = form_field.value
 if key == "@action_name":
 name = value
 elif key.startswith('@action_args'):
 'link': '%s/%s/%s' % (self.data_path, class_name, item_id),
 'result': result
 }
 else:
 # else patch operation is processing data
-props = self.props_from_args(class_obj, input.value, item_id,
+props = self.props_from_args(class_obj, input_payload.value, item_id,
 skip_protected=False)
 required_props = class_obj.get_required_props()
 for prop in props:
 if not self.db.security.hasPermission(
 }
 return 200, result
 @Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'PATCH')
 @_data_decorator
-def patch_attribute(self, class_name, item_id, attr_name, input):
+def patch_attribute(self, class_name, item_id, attr_name, input_payload):
 """PATCH an attribute of an object
 Patch an element using 3 operators
 ADD : Append new value to the attribute
 REPLACE: Replace attribute
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
 item_id (string): id of the resource (Ex: 12, 15)
 attr_name (string): attribute of the resource (Ex: title, nosy)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 dict: a dictionary represents the modified object
 id: id of the object
 the object
 """
 if class_name not in self.db.classes:
 raise NotFound('Class %s not found' % class_name)
 try:
-op = input['@op'].value.lower()
+op = input_payload['@op'].value.lower()
 except KeyError:
 op = self.__default_patch_op
 if not self.db.security.hasPermission(
 'Edit', self.db.getuid(), class_name, attr_name, item_id
 if attr_name not in class_obj.getprops(protected=False):
 if attr_name in class_obj.getprops(protected=True):
 raise AttributeError("Attribute '%s' can not be updated "
 "for class %s." % (attr_name, class_name))
-self.raise_if_no_etag(class_name, item_id, input)
+self.raise_if_no_etag(class_name, item_id, input_payload)
 props = {
 prop: self.prop_from_arg(
-class_obj, prop, input['data'].value, item_id
+class_obj, prop, input_payload['data'].value, item_id
 )
 }
 props[prop] = self.patch_data(
 op, class_obj.get(item_id, prop), props[prop]
 }
 return 200, result
 @Routing.route("/data/<:class_name>", 'OPTIONS')
 @_data_decorator
-def options_collection(self, class_name, input):
+def options_collection(self, class_name, input_payload):
 """OPTION return the HTTP Header for the class uri
 Returns:
 int: http status code 204 (No content)
 body (string): an empty string
 )
 return 204, ""
 @Routing.route("/data/<:class_name>/<:item_id>", 'OPTIONS')
 @_data_decorator
-def options_element(self, class_name, item_id, input):
+def options_element(self, class_name, item_id, input_payload):
 """OPTION return the HTTP Header for the object uri
 Returns:
 int: http status code 204 (No content)
 body (string): an empty string
 )
 return 204, ""
 @Routing.route("/data/<:class_name>/<:item_id>/<:attr_name>", 'OPTIONS')
 @_data_decorator
-def option_attribute(self, class_name, item_id, attr_name, input):
+def option_attribute(self, class_name, item_id, attr_name, input_payload):
 """OPTION return the HTTP Header for the attribute uri
 Returns:
 int: http status code 204 (No content)
 body (string): an empty string
 }
 }
 )
 @Routing.route("/")
 @_data_decorator
-def describe(self, input):
+def describe(self, input_payload):
 """Describe the rest endpoint. Return direct children in
 links list.
 """
 # paths looks like ['^rest/$', '^rest/summary$',
 return 200, result
 @Routing.route("/", 'OPTIONS')
 @_data_decorator
-def options_describe(self, input):
+def options_describe(self, input_payload):
 """OPTION return the HTTP Header for the root
 Returns:
 int: http status code 204 (No content)
 body (string): an empty string
 )
 return 204, ""
 @Routing.route("/data")
 @_data_decorator
-def data(self, input):
+def data(self, input_payload):
 """Describe the subelements of data
 One entry for each class the user may view
 """
 result = {}
 result[cls] = dict(link=self.base_path + '/data/' + cls)
 return 200, result
 @Routing.route("/data", 'OPTIONS')
 @_data_decorator
-def options_data(self, input):
+def options_data(self, input_payload):
 """OPTION return the HTTP Header for the /data element
 Returns:
 int: http status code 204 (No content)
 body (string): an empty string
 )
 return 204, ""
 @Routing.route("/summary")
 @_data_decorator
-def summary(self, input):
+def summary(self, input_payload):
 """Get a summary of resource from class URI.
 This function returns only items have View permission
 class_name should be valid already
 Args:
 class_name (string): class name of the resource (Ex: issue, msg)
-input (list): the submitted form of the user
+input_payload (list): the submitted form of the user
 Returns:
 int: http status code 200 (OK)
 list:
 """
 "Acceptable mime types are: */*, %s") %
 (self.client.request.headers.get('Accept'),
 ", ".join(sorted(
 self.__accepted_content_type.keys())))))
-def dispatch(self, method, uri, input):
+def dispatch(self, method, uri, input_payload):
 """format and process the request"""
 output = None
 # Before we do anything has the user hit the rate limit.
 self.client.setHeader(
 "Allow",
 "OPTIONS, GET, POST, PUT, DELETE, PATCH"
 )
-# Is there an input.value with format json data?
+# Is there an input_payload.value with format json data?
 # If so turn it into an object that emulates enough
 # of the FieldStorge methods/props to allow a response.
 content_type_header = headers.get('Content-Type', None)
 # python2 is str type, python3 is bytes
-if type(input.value) in (str, bytes) and content_type_header:
+if type(input_payload.value) in (str, bytes) and content_type_header:
 # the structure of a content-type header
 # is complex: mime-type; options(charset ...)
 # for now we just accept application/json.
 # FIXME there should be a function:
 #   parse_content_type_header(content_type_header)
 # That way we could handle stuff like:
 #  application/vnd.roundup-foo+json; charset=UTF8
 # for example.
 if content_type_header.lower() == "application/json":
 try:
-input = SimulateFieldStorageFromJson(b2s(input.value))
+input_payload = SimulateFieldStorageFromJson(b2s(input_payload.value))
 except ValueError as msg:
 output = self.error_obj(400, msg)
 else:
 if method.upper() == "PATCH":
 self.client.setHeader("Accept-Patch",
 "Unable to process input of type %s" %
 content_type_header)
 # check for pretty print
 try:
-pretty_output = not input['@pretty'].value.lower() == "false"
+pretty_output = not input_payload['@pretty'].value.lower() == "false"
 # Can also return a TypeError ("not indexable")
 # In case the FieldStorage could not parse the result
 except (KeyError, TypeError):
 pretty_output = True
 # check for runtime statistics
 try:
 # self.report_stats initialized to False
-self.report_stats = input['@stats'].value.lower() == "true"
+self.report_stats = input_payload['@stats'].value.lower() == "true"
 # Can also return a TypeError ("not indexable")
 # In case the FieldStorage could not parse the result
 except (KeyError, TypeError):
 pass
 try:
 # FIXME: the version priority here is different
 # from accept header. accept mime type in url
 # takes priority over Accept header. Opposite here.
 if not self.api_version:
-self.api_version = int(input['@apiver'].value)
+self.api_version = int(input_payload['@apiver'].value)
 # Can also return a TypeError ("not indexable")
 # In case the FieldStorage could not parse the result
 except (KeyError, TypeError):
 self.api_version = None
 except ValueError:
-output = self.error_obj(406, msg % input['@apiver'].value)
+output = self.error_obj(406, msg % input_payload['@apiver'].value)
 # by this time the API version is set. Error if we don't
 # support it?
 if self.api_version is None:
 # FIXME: do we need to raise an error if client did not specify
 self.api_version = self.__default_api_version
 elif self.api_version not in self.__supported_api_versions:
 output = self.error_obj(406, msg % self.api_version)
 # sadly del doesn't work on FieldStorage which can be the type of
-# input. So we have to ignore keys starting with @ at other
+# input_payload. So we have to ignore keys starting with @ at other
 # places in the code.
 # else:
-#     del(input['@apiver'])
+#     del(input_payload['@apiver'])
 # Call the appropriate method
 try:
 # If output was defined by a prior error
 # condition skip call
 if not output:
-output = Routing.execute(self, uri, method, input)
+output = Routing.execute(self, uri, method, input_payload)
 except NotFound as msg:
 output = self.error_obj(404, msg)
 except Reject as msg:
 output = self.error_obj(405, msg.args[0])
 self.client.setHeader("Allow", msg.args[1])

Mercurial > p > roundup > code

comparison roundup/rest.py @ 8188:e5362f8e1808