fix: add docs, tests; tweak some handler method signatures
This commit is contained in:
parent
e4a4e85cf6
commit
d11e186df9
16 changed files with 345 additions and 15 deletions
|
@ -38,6 +38,11 @@ class CoreposHandler(GenericHandler):
|
|||
Returns the base URL for the CORE Office web app.
|
||||
|
||||
Note that the return value is stripped of final slash.
|
||||
|
||||
:param require: If true, an error is raised when URL cannot be
|
||||
determined.
|
||||
|
||||
:returns: URL as string.
|
||||
"""
|
||||
url = self.config.get('corepos.office.url', require=require)
|
||||
if url:
|
||||
|
@ -45,40 +50,64 @@ class CoreposHandler(GenericHandler):
|
|||
|
||||
def get_office_department_url(
|
||||
self,
|
||||
number,
|
||||
dept_id,
|
||||
office_url=None,
|
||||
require=False,
|
||||
**kwargs):
|
||||
require=False):
|
||||
"""
|
||||
Returns the CORE Office URL for a Department.
|
||||
|
||||
:param dept_id: Department ID for the URL.
|
||||
|
||||
:param office_url: Root URL from :meth:`get_office_url()`.
|
||||
|
||||
:param require: If true, an error is raised when URL cannot be
|
||||
determined.
|
||||
|
||||
:returns: URL as string.
|
||||
"""
|
||||
if not office_url:
|
||||
office_url = self.get_office_url(require=require)
|
||||
if office_url:
|
||||
return f'{office_url}/item/departments/DepartmentEditor.php?did={number}'
|
||||
return f'{office_url}/item/departments/DepartmentEditor.php?did={dept_id}'
|
||||
|
||||
def get_office_likecode_url(
|
||||
self,
|
||||
id,
|
||||
likecode_id,
|
||||
office_url=None,
|
||||
require=False,
|
||||
**kwargs):
|
||||
require=False):
|
||||
"""
|
||||
Returns the CORE Office URL for a Like Code.
|
||||
|
||||
:param likecode_id: Like Code ID for the URL.
|
||||
|
||||
:param office_url: Root URL from :meth:`get_office_url()`.
|
||||
|
||||
:param require: If true, an error is raised when URL cannot be
|
||||
determined.
|
||||
|
||||
:returns: URL as string.
|
||||
"""
|
||||
if not office_url:
|
||||
office_url = self.get_office_url(require=require)
|
||||
if office_url:
|
||||
return f'{office_url}/item/likecodes/LikeCodeEditor.php?start={id}'
|
||||
return f'{office_url}/item/likecodes/LikeCodeEditor.php?start={likecode_id}'
|
||||
|
||||
def get_office_product_url(
|
||||
self,
|
||||
upc,
|
||||
office_url=None,
|
||||
require=False,
|
||||
**kwargs):
|
||||
require=False):
|
||||
"""
|
||||
Returns the CORE Office URL for a Product.
|
||||
|
||||
:param upc: UPC for the URL.
|
||||
|
||||
:param office_url: Root URL from :meth:`get_office_url()`.
|
||||
|
||||
:param require: If true, an error is raised when URL cannot be
|
||||
determined.
|
||||
|
||||
:returns: URL as string.
|
||||
"""
|
||||
if not office_url:
|
||||
office_url = self.get_office_url(require=require)
|
||||
|
@ -87,14 +116,22 @@ class CoreposHandler(GenericHandler):
|
|||
|
||||
def get_office_vendor_url(
|
||||
self,
|
||||
id,
|
||||
vend_id,
|
||||
office_url=None,
|
||||
require=False,
|
||||
**kwargs):
|
||||
require=False):
|
||||
"""
|
||||
Returns the CORE Office URL for a Vendor.
|
||||
|
||||
:param vend_id: Vendor ID for the URL.
|
||||
|
||||
:param office_url: Root URL from :meth:`get_office_url()`.
|
||||
|
||||
:param require: If true, an error is raised when URL cannot be
|
||||
determined.
|
||||
|
||||
:returns: URL as string.
|
||||
"""
|
||||
if not office_url:
|
||||
office_url = self.get_office_url(require=require)
|
||||
if office_url:
|
||||
return f'{office_url}/item/vendors/VendorIndexPage.php?vid={id}'
|
||||
return f'{office_url}/item/vendors/VendorIndexPage.php?vid={vend_id}'
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue