cloudofficeprint
@@ -183,15 +155,19 @@Usage
The examples below call this package cop.
-import cloudofficeprint as cop
-
+
import cloudofficeprint as cop
+Templates
Templates are represented by Resource. The simplest way to obtain a Resource is to load from a local path.
template = cop.Resource.from_local_file("./path/to/template.docx")
-
+
template = cop.Resource.from_local_file("./path/to/template.docx")
+Render elements
@@ -199,7 +175,8 @@Render elements
Combining a simple line chart and some text tags:
-line = cop.elements.LineChart(
+
+line = cop.elements.LineChart(
"linechart",
cop.elements.LineSeries([1, 2, 3, 4], [1, 2, 3, 4], color="green"),
cop.elements.XYSeries([1, 2, 3, 4], ["a", "b", "c", "d"])
@@ -217,554 +194,398 @@ Render elements
combined_data.add(line)
combined_data.add(text_tag)
combined_data.add_all(text_tags)
-
+The server
A Cloud Office Print server is configured as a config.Server. It takes a url and an optional config.ServerConfig which allows for various server configuration options. If you're using Cloud Office Print Cloud edition, you will need to use this to declare your API key.
server = cop.config.Server(
+
+server = cop.config.Server(
"http://server.url.com/",
cop.config.ServerConfig(api_key = "YOUR_API_KEY")
)
-
+Print job
PrintJob combines template, data, server and an optional output configuration (config.OutputConfig) and can execute itself on the Cloud Office Print server. An example using the variables declared above:
printjob = cop.PrintJob(combined_data, server, template)
+
+printjob = cop.PrintJob(combined_data, server, template)
printjob.execute()
-
+A print job can be executed asynchronously as well.
-import asyncio
+
+import asyncio
coroutine = printjob.execute_async()
# simply await your result when you need it
result = await coroutine
-
+Full JSON available
If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server for you (requests are made using requests).
-json_data = open("./path/to/data.json", "r").read()
+
+json_data = open("./path/to/data.json", "r").read()
cop.PrintJob.execute_full_json(
json_data, server
).to_file("./test/from_full_json_output")
-
+Server errors
In case the Cloud Office Print server returns an error, PrintJob will throw one as well.
You can catch it and get either its user-readable message or an encoded stack trace that can be passed to Cloud Office Print support.
try:
+
+try:
# execute some previously constructed printjob
printjob.execute()
except cop.exceptions.COPError as err:
print("Cloud Office Print error! " + err.user_message)
print(err.encoded_message)
...
-
+Further information
For further information, such as where to find our examples, we refer to our README.md file on our Github page.
-
-
-
-
-
- View Source
-""" -This Python package provides a programmatic interface with a [Cloud Office Print](https://www.cloudofficeprint.com) server. - -## Usage -The examples below call this package cop. -```python -import cloudofficeprint as cop -``` - -### Templates -Templates are represented by `Resource`. The simplest way to obtain a `Resource` is to load from a local path. -```python -template = cop.Resource.from_local_file("./path/to/template.docx") -``` - -### Render elements -Most render elements encapsulate the data for a single tag. An `elements.ElementCollection` is an element which represents a collection of elements. - -Combining a simple line chart and some text tags: -```python -line = cop.elements.LineChart( - "linechart", - cop.elements.LineSeries([1, 2, 3, 4], [1, 2, 3, 4], color="green"), - cop.elements.XYSeries([1, 2, 3, 4], ["a", "b", "c", "d"]) -) - -text_tag = cop.elements.Property("tag-name", "Hello, world!") -# or multiple at once using ElementCollection.from_mapping -# and supplying the dictionary representation directly -text_tags = cop.elements.ElementCollection.from_mapping({ - "another-tag": "Foo", - "one-more-tag": "Bar" -}) - -combined_data = cop.elements.ElementCollection() -combined_data.add(line) -combined_data.add(text_tag) -combined_data.add_all(text_tags) -``` - -### The server -A Cloud Office Print server is configured as a `config.Server`. It takes a url and an optional `config.ServerConfig` which allows for various server configuration options. If you're using Cloud Office Print Cloud edition, you will need to use this to declare your API key. - -```python -server = cop.config.Server( - "http://server.url.com/", - cop.config.ServerConfig(api_key = "YOUR_API_KEY") -) -``` - -### Print job -`PrintJob` combines template, data, server and an optional output configuration (`config.OutputConfig`) and can execute itself on the Cloud Office Print server. An example using the variables declared above: - -```python -printjob = cop.PrintJob(combined_data, server, template) -printjob.execute() -``` - -A print job can be executed asynchronously as well. - -```python -import asyncio -coroutine = printjob.execute_async() -# simply await your result when you need it -result = await coroutine -``` - -### Full JSON available -If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server for you (requests are made using [requests](https://requests.readthedocs.io/en/master/)). -```python -json_data = open("./path/to/data.json", "r").read() -cop.PrintJob.execute_full_json( - json_data, server - ).to_file("./test/from_full_json_output") -``` - -### Server errors -In case the Cloud Office Print server returns an error, `PrintJob` will throw one as well. -You can catch it and get either its user-readable message or an encoded stack trace that can be passed to Cloud Office Print support. -```python -try: - # execute some previously constructed printjob - printjob.execute() -except cop.exceptions.COPError as err: - print("Cloud Office Print error! " + err.user_message) - print(err.encoded_message) - ... -``` - -### Further information -For further information, such as where to find our examples, we refer to our README.md file on our [Github page](https://github.com/United-Codes/cloudofficeprint-python/). -""" - -from . import exceptions, config, elements, own_utils - -from .printjob import PrintJob -from .resource import Resource -from .response import Response - -# specify what is imported on "from cloudofficeprint import *" -# but that shouldn't really be used anyway -__all__ = [ - "exceptions", - "config", - "elements", - "own_utils", - "PrintJob", - "Resource", - "Response" -] -
-
-
-
-
- View Source
-"""Custom exceptions for cloudofficeprint.""" - -from typing import List - - -class COPError(Exception): - """The error that is thrown when the Cloud Office Print server itself returns an error instead of a result. - - It contains a user message and an encoded message to be handed to Cloud Office Print support if they are contacted. - """ - - def __init__(self, full_message: str): - """ - Args: - full_message (str): the full error message received from the Cloud Office Print server - """ - (self._user_message, - self._contact_support_message, - self._encoded_message) = self._split_message(full_message) - super().__init__(self._user_message) - - @staticmethod - def _split_message(message: str) -> List[str]: - """Split the Cloud Office Print server error message into different parts: user message, contact support message and encoded message. - - Args: - message (str): Cloud Office Print server error message - - Returns: - List[str]: a list with the split messages - """ - separated = message.split("\n") - # everything before the last 2 lines are considered user message - user_message = "\n".join(separated[:-2]) - # second to last line contains the support message - contact_support_message = separated[-2] - # last line contains the encoded message - encoded_message = separated[-1] - return [user_message, contact_support_message, encoded_message] - - @property - def encoded_message(self) -> str: - """The encrypted and encoded part of the message, for Cloud Office Print support. - - Returns: - str: the encrypted and encoded part of the message, for Cloud Office Print support - """ - return self._encoded_message - - @property - def user_message(self) -> str: - """The user-friendly part of the message. - - Returns: - str: the user-friendly part of the message - """ - return self._user_message - - @property - def contact_support_message(self) -> str: - """The contact support message. - - Returns: - str: the contact support message - """ - return self._contact_support_message - - @property - def full_message(self) -> str: - """The full error message as sent by the server. - - Returns: - str: the full error message as sent by the server - """ - return self.user_message + "\n" + self.contact_support_message + "\n" + self.encoded_message -
Custom exceptions for cloudofficeprint.
-
-
-
-
-
- View Source
-""" -Module for output configurations. - -The classes under this module encapsulate various configuration options for a print job. -They are to be used with `cloudofficeprint.printjob.PrintJob`. -""" - -from .cloud import * -from .csv import * -from .output import * -from .pdf import * -from .server import * -
Module for output configurations.
- -The classes under this module encapsulate various configuration options for a print job.
-They are to be used with cloudofficeprint.printjob.PrintJob.
-
-
-
-
- View Source
-""" -Elements are used to replace the various tags in a template with actual data. -""" - -from .charts import * -from .codes import * -from .elements import * -from .images import * -from .loops import * -from .pdf import * -from .rest_source import * -
Elements are used to replace the various tags in a template with actual data.
-
-
-
-
-
- View Source
-""" -Helper functions. -""" - -from .file_utils import * -from .type_utils import * -
Helper functions.
-1""" + 2This Python package provides a programmatic interface with a [Cloud Office Print](https://www.cloudofficeprint.com) server. + 3 + 4## Usage + 5The examples below call this package cop. + 6```python + 7import cloudofficeprint as cop + 8``` + 9 + 10### Templates + 11Templates are represented by `Resource`. The simplest way to obtain a `Resource` is to load from a local path. + 12```python + 13template = cop.Resource.from_local_file("./path/to/template.docx") + 14``` + 15 + 16### Render elements + 17Most render elements encapsulate the data for a single tag. An `elements.ElementCollection` is an element which represents a collection of elements. + 18 + 19Combining a simple line chart and some text tags: + 20```python + 21line = cop.elements.LineChart( + 22 "linechart", + 23 cop.elements.LineSeries([1, 2, 3, 4], [1, 2, 3, 4], color="green"), + 24 cop.elements.XYSeries([1, 2, 3, 4], ["a", "b", "c", "d"]) + 25) + 26 + 27text_tag = cop.elements.Property("tag-name", "Hello, world!") + 28# or multiple at once using ElementCollection.from_mapping + 29# and supplying the dictionary representation directly + 30text_tags = cop.elements.ElementCollection.from_mapping({ + 31 "another-tag": "Foo", + 32 "one-more-tag": "Bar" + 33}) + 34 + 35combined_data = cop.elements.ElementCollection() + 36combined_data.add(line) + 37combined_data.add(text_tag) + 38combined_data.add_all(text_tags) + 39``` + 40 + 41### The server + 42A Cloud Office Print server is configured as a `config.Server`. It takes a url and an optional `config.ServerConfig` which allows for various server configuration options. If you're using Cloud Office Print Cloud edition, you will need to use this to declare your API key. + 43 + 44```python + 45server = cop.config.Server( + 46 "http://server.url.com/", + 47 cop.config.ServerConfig(api_key = "YOUR_API_KEY") + 48) + 49``` + 50 + 51### Print job + 52`PrintJob` combines template, data, server and an optional output configuration (`config.OutputConfig`) and can execute itself on the Cloud Office Print server. An example using the variables declared above: + 53 + 54```python + 55printjob = cop.PrintJob(combined_data, server, template) + 56printjob.execute() + 57``` + 58 + 59A print job can be executed asynchronously as well. + 60 + 61```python + 62import asyncio + 63coroutine = printjob.execute_async() + 64# simply await your result when you need it + 65result = await coroutine + 66``` + 67 + 68### Full JSON available + 69If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server for you (requests are made using [requests](https://requests.readthedocs.io/en/master/)). + 70```python + 71json_data = open("./path/to/data.json", "r").read() + 72cop.PrintJob.execute_full_json( + 73 json_data, server + 74 ).to_file("./test/from_full_json_output") + 75``` + 76 + 77### Server errors + 78In case the Cloud Office Print server returns an error, `PrintJob` will throw one as well. + 79You can catch it and get either its user-readable message or an encoded stack trace that can be passed to Cloud Office Print support. + 80```python + 81try: + 82 # execute some previously constructed printjob + 83 printjob.execute() + 84except cop.exceptions.COPError as err: + 85 print("Cloud Office Print error! " + err.user_message) + 86 print(err.encoded_message) + 87 ... + 88``` + 89 + 90### Further information + 91For further information, such as where to find our examples, we refer to our README.md file on our [Github page](https://github.com/United-Codes/cloudofficeprint-python/). + 92""" + 93 + 94from . import exceptions, config, elements, own_utils + 95 + 96from .printjob import PrintJob + 97from .resource import Resource + 98from .response import Response + 99 +100# specify what is imported on "from cloudofficeprint import *" +101# but that shouldn't really be used anyway +102__all__ = [ +103 "exceptions", +104 "config", +105 "elements", +106 "own_utils", +107 "PrintJob", +108 "Resource", +109 "Response" +110] +
- #
+
+
-
+
+ class
+ PrintJob:
+
+
-
- class
- PrintJob:
+
+ 27class PrintJob: + 28 """A print job for a Cloud Office Print server. + 29 + 30 This class contains all configuration options, resources, render elements ... + 31 and the `PrintJob.execute` method to combine all these and send a request to the Cloud Office Print server. + 32 """ + 33 + 34 def __init__(self, + 35 data: Union[Element, Mapping[str, Element], RESTSource], + 36 server: Server, + 37 template: Resource = None, + 38 output_config: OutputConfig = OutputConfig(), + 39 subtemplates: Dict[str, Resource] = {}, + 40 prepend_files: List[Resource] = [], + 41 append_files: List[Resource] = [], + 42 cop_verbose: bool = False): + 43 """ + 44 Args: + 45 data (Union[Element, Mapping[str, Element], RESTSource]): This is either: An `Element` (e.g. an `ElementCollection`); A mapping, containing file names as keys and an `Element` as data. Multiple files will be produced from the different datas, the result is a zip file containing them. In the first case, no output file name is specified and the server will name it "file0". + 46 server (Server): Server to be used for this print job. + 47 template (Resource): Template to use for this print job. + 48 output_config (OutputConfig, optional): Output configuration to be used for this print job. Defaults to `OutputConfig`(). + 49 subtemplates (Dict[str, Resource], optional): Subtemplates for this print job, accessible (in docx) through `{?include subtemplate_dict_key}`. Defaults to {}. + 50 prepend_files (List[Resource], optional): Files to prepend to the output file. Defaults to []. + 51 append_files (List[Resource], optional): Files to append to the output file. Defaults to []. + 52 cop_verbose (bool, optional): Whether or not verbose mode should be activated. Defaults to False. + 53 """ + 54 + 55 self.data: Union[Element, Mapping[str, Element], RESTSource] = data + 56 self.server: Server = server + 57 self.output_config: OutputConfig = output_config + 58 self.template: Resource = template + 59 self.subtemplates: Dict[str, Resource] = subtemplates + 60 self.prepend_files: List[Resource] = prepend_files + 61 self.append_files: List[Resource] = append_files + 62 self.cop_verbose: bool = cop_verbose + 63 + 64 def execute(self) -> Response: + 65 """Execute this print job. + 66 + 67 Returns: + 68 Response: `Response`-object + 69 """ + 70 self.server._raise_if_unreachable() + 71 return self._handle_response(requests.post(self.server.url, proxies=self.server.config.proxies if self.server.config is not None else None, json=self.as_dict, headers={"Content-type": "application/json"})) + 72 + 73 async def execute_async(self) -> Response: + 74 """Async version of `PrintJob.execute` + 75 + 76 Returns: + 77 Response: `Response`-object + 78 """ + 79 self.server._raise_if_unreachable() + 80 return PrintJob._handle_response( + 81 await asyncio.get_event_loop().run_in_executor( + 82 None, partial( + 83 requests.post, + 84 self.server.url, + 85 proxies=self.server.config.proxies if self.server.config is not None else None, + 86 json=self.as_dict + 87 ) + 88 ) + 89 ) + 90 + 91 @staticmethod + 92 def execute_full_json(json_data: str, server: Server) -> Response: + 93 """If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server. + 94 + 95 Args: + 96 json_data (str): full JSON data that needs to be sent to a Cloud Office Print server + 97 server (Server): `Server`-object + 98 + 99 Returns: +100 Response: `Response`-object +101 """ +102 server._raise_if_unreachable() +103 return PrintJob._handle_response(requests.post(server.url, proxies=server.config.proxies if server.config is not None else None, data=json_data, headers={"Content-type": "application/json"})) +104 +105 @staticmethod +106 async def execute_full_json_async(json_data: str, server: Server) -> Response: +107 """Async version of `Printjob.execute_full_json` +108 +109 Args: +110 json_data (str): full JSON data that needs to be sent to a Cloud Office Print server +111 server (Server): `Server`-object +112 +113 Returns: +114 Response: `Response`-object +115 """ +116 server._raise_if_unreachable() +117 return PrintJob._handle_response( +118 await asyncio.get_event_loop().run_in_executor( +119 None, partial( +120 requests.post, +121 server.url, +122 proxies=server.config.proxies if server.config is not None else None, +123 data=json_data, +124 headers={"Content-type": "application/json"} +125 ) +126 ) +127 ) +128 +129 @staticmethod +130 def _handle_response(res: requests.Response) -> Response: +131 """Converts the HTML response to a `Response`-object +132 +133 Args: +134 res (requests.Response): HTML response from the Cloud Office Print server +135 +136 Raises: +137 COPError: Error when the HTML status code is not 200 +138 +139 Returns: +140 Response: `Response`-object of HTML response +141 """ +142 if res.status_code != 200: +143 raise COPError(res.text) +144 else: +145 return Response(res) +146 +147 @property +148 def json(self) -> str: +149 """JSON equivalent of the dict representation of this print job. +150 This representation is isomorphic to the dict representation `Printjob.as_dict`. +151 +152 Returns: +153 str: JSON equivalent of the dict representation of this print job +154 """ +155 return json.dumps(self.as_dict) +156 +157 @property +158 def as_dict(self) -> Dict: +159 """Return the dict representation of this print job. +160 +161 Returns: +162 Dict: dict representation of this print job +163 """ +164 result = dict( +165 STATIC_OPTS) # Copy of STATIC_OPTS! Otherwise everything we add to 'result' will also be added to 'STATIC_OPTS' +166 # server config goes in the upper level +167 if self.server.config: +168 result.update(self.server.config.as_dict) +169 +170 # output config goes in "output" +171 # and decides where its sub-configs go through its as_dict property +172 # (e.g. PDFConfigs are just appended at this "output" level) +173 result["output"] = self.output_config.as_dict +174 +175 if self.template: +176 result["template"] = self.template.template_dict +177 +178 # If output_type is not specified, set this to the template filetype +179 # If no template found: default docx +180 if 'output_type' not in self.output_config.as_dict.keys(): +181 if self.template: +182 result['output']['output_type'] = result['template']['template_type'] +183 else: +184 result['output']['output_type'] = 'docx' +185 +186 if isinstance(self.data, Mapping): +187 result["files"] = [{ +188 "filename": name, +189 "data": data.as_dict +190 } for name, data in self.data.items()] +191 elif isinstance(self.data, RESTSource): +192 result['files'] = [self.data.as_dict] +193 else: +194 result["files"] = [{"data": self.data.as_dict}] +195 +196 if len(self.prepend_files) > 0: +197 result["prepend_files"] = [ +198 res.secondary_file_dict for res in self.prepend_files +199 ] +200 +201 if len(self.append_files) > 0: +202 result["append_files"] = [ +203 res.secondary_file_dict for res in self.append_files +204 ] +205 +206 if len(self.subtemplates) > 0: +207 templates_list = [] +208 for name, res in self.subtemplates.items(): +209 to_add = res.secondary_file_dict +210 to_add["name"] = name +211 templates_list.append(to_add) +212 result["templates"] = templates_list +213 +214 # If verbose mode is activated, print the result to the terminal +215 if self.cop_verbose: +216 print('The JSON data that is sent to the Cloud Office Print server:\n') +217 pprint(result) +218 +219 return result +
-
-
-
View Source
-class PrintJob: - """A print job for a Cloud Office Print server. - - This class contains all configuration options, resources, render elements ... - and the `PrintJob.execute` method to combine all these and send a request to the Cloud Office Print server. - """ - - def __init__(self, - data: Union[Element, Mapping[str, Element], RESTSource], - server: Server, - template: Resource = None, - output_config: OutputConfig = OutputConfig(), - subtemplates: Dict[str, Resource] = {}, - prepend_files: List[Resource] = [], - append_files: List[Resource] = [], - cop_verbose: bool = False): - """ - Args: - data (Union[Element, Mapping[str, Element], RESTSource]): This is either: An `Element` (e.g. an `ElementCollection`); A mapping, containing file names as keys and an `Element` as data. Multiple files will be produced from the different datas, the result is a zip file containing them. In the first case, no output file name is specified and the server will name it "file0". - server (Server): Server to be used for this print job. - template (Resource): Template to use for this print job. - output_config (OutputConfig, optional): Output configuration to be used for this print job. Defaults to `OutputConfig`(). - subtemplates (Dict[str, Resource], optional): Subtemplates for this print job, accessible (in docx) through `{?include subtemplate_dict_key}`. Defaults to {}. - prepend_files (List[Resource], optional): Files to prepend to the output file. Defaults to []. - append_files (List[Resource], optional): Files to append to the output file. Defaults to []. - cop_verbose (bool, optional): Whether or not verbose mode should be activated. Defaults to False. - """ - - self.data: Union[Element, Mapping[str, Element], RESTSource] = data - self.server: Server = server - self.output_config: OutputConfig = output_config - self.template: Resource = template - self.subtemplates: Dict[str, Resource] = subtemplates - self.prepend_files: List[Resource] = prepend_files - self.append_files: List[Resource] = append_files - self.cop_verbose: bool = cop_verbose - - def execute(self) -> Response: - """Execute this print job. - - Returns: - Response: `Response`-object - """ - self.server._raise_if_unreachable() - return self._handle_response(requests.post(self.server.url, proxies=self.server.config.proxies if self.server.config is not None else None, json=self.as_dict, headers={"Content-type": "application/json"})) - - async def execute_async(self) -> Response: - """Async version of `PrintJob.execute` - - Returns: - Response: `Response`-object - """ - self.server._raise_if_unreachable() - return PrintJob._handle_response( - await asyncio.get_event_loop().run_in_executor( - None, partial( - requests.post, - self.server.url, - proxies=self.server.config.proxies if self.server.config is not None else None, - json=self.as_dict - ) - ) - ) - - @staticmethod - def execute_full_json(json_data: str, server: Server) -> Response: - """If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server. - - Args: - json_data (str): full JSON data that needs to be sent to a Cloud Office Print server - server (Server): `Server`-object - - Returns: - Response: `Response`-object - """ - server._raise_if_unreachable() - return PrintJob._handle_response(requests.post(server.url, proxies=server.config.proxies if server.config is not None else None, data=json_data, headers={"Content-type": "application/json"})) - - @staticmethod - async def execute_full_json_async(json_data: str, server: Server) -> Response: - """Async version of `Printjob.execute_full_json` - - Args: - json_data (str): full JSON data that needs to be sent to a Cloud Office Print server - server (Server): `Server`-object - - Returns: - Response: `Response`-object - """ - server._raise_if_unreachable() - return PrintJob._handle_response( - await asyncio.get_event_loop().run_in_executor( - None, partial( - requests.post, - server.url, - proxies=server.config.proxies if server.config is not None else None, - data=json_data, - headers={"Content-type": "application/json"} - ) - ) - ) - - @staticmethod - def _handle_response(res: requests.Response) -> Response: - """Converts the HTML response to a `Response`-object - - Args: - res (requests.Response): HTML response from the Cloud Office Print server - - Raises: - COPError: Error when the HTML status code is not 200 - - Returns: - Response: `Response`-object of HTML response - """ - if res.status_code != 200: - raise COPError(res.text) - else: - return Response(res) - - @property - def json(self) -> str: - """JSON equivalent of the dict representation of this print job. - This representation is isomorphic to the dict representation `Printjob.as_dict`. - - Returns: - str: JSON equivalent of the dict representation of this print job - """ - return json.dumps(self.as_dict) - - @property - def as_dict(self) -> Dict: - """Return the dict representation of this print job. - - Returns: - Dict: dict representation of this print job - """ - result = dict( - STATIC_OPTS) # Copy of STATIC_OPTS! Otherwise everything we add to 'result' will also be added to 'STATIC_OPTS' - # server config goes in the upper level - if self.server.config: - result.update(self.server.config.as_dict) - - # output config goes in "output" - # and decides where its sub-configs go through its as_dict property - # (e.g. PDFConfigs are just appended at this "output" level) - result["output"] = self.output_config.as_dict - - if self.template: - result["template"] = self.template.template_dict - - # If output_type is not specified, set this to the template filetype - # If no template found: default docx - if 'output_type' not in self.output_config.as_dict.keys(): - if self.template: - result['output']['output_type'] = result['template']['template_type'] - else: - result['output']['output_type'] = 'docx' - - if isinstance(self.data, Mapping): - result["files"] = [{ - "filename": name, - "data": data.as_dict - } for name, data in self.data.items()] - elif isinstance(self.data, RESTSource): - result['files'] = [self.data.as_dict] - else: - result["files"] = [{"data": self.data.as_dict}] - - if len(self.prepend_files) > 0: - result["prepend_files"] = [ - res.secondary_file_dict for res in self.prepend_files - ] - - if len(self.append_files) > 0: - result["append_files"] = [ - res.secondary_file_dict for res in self.append_files - ] - - if len(self.subtemplates) > 0: - templates_list = [] - for name, res in self.subtemplates.items(): - to_add = res.secondary_file_dict - to_add["name"] = name - templates_list.append(to_add) - result["templates"] = templates_list - - # If verbose mode is activated, print the result to the terminal - if self.cop_verbose: - print('The JSON data that is sent to the Cloud Office Print server:\n') - pprint(result) - - return result -
A print job for a Cloud Office Print server.
@@ -774,55 +595,46 @@Further information
-
#
+
+
-
+
+ PrintJob( data: Union[cloudofficeprint.elements.elements.Element, Mapping[str, cloudofficeprint.elements.elements.Element], cloudofficeprint.elements.rest_source.RESTSource], server: cloudofficeprint.config.server.Server, template: cloudofficeprint.Resource = None, output_config: cloudofficeprint.config.output.OutputConfig = <cloudofficeprint.config.output.OutputConfig object>, subtemplates: Dict[str, cloudofficeprint.Resource] = {}, prepend_files: List[cloudofficeprint.Resource] = [], append_files: List[cloudofficeprint.Resource] = [], cop_verbose: bool = False)
+
+
-
- PrintJob(
- data: Union[cloudofficeprint.elements.elements.Element, Mapping[str, cloudofficeprint.elements.elements.Element], cloudofficeprint.elements.rest_source.RESTSource],
- server: cloudofficeprint.config.server.Server,
- template: cloudofficeprint.resource.Resource = None,
- output_config: cloudofficeprint.config.output.OutputConfig = <cloudofficeprint.config.output.OutputConfig object>,
- subtemplates: Dict[str, cloudofficeprint.resource.Resource] = {},
- prepend_files: List[cloudofficeprint.resource.Resource] = [],
- append_files: List[cloudofficeprint.resource.Resource] = [],
- cop_verbose: bool = False
-)
+
+ 34 def __init__(self, +35 data: Union[Element, Mapping[str, Element], RESTSource], +36 server: Server, +37 template: Resource = None, +38 output_config: OutputConfig = OutputConfig(), +39 subtemplates: Dict[str, Resource] = {}, +40 prepend_files: List[Resource] = [], +41 append_files: List[Resource] = [], +42 cop_verbose: bool = False): +43 """ +44 Args: +45 data (Union[Element, Mapping[str, Element], RESTSource]): This is either: An `Element` (e.g. an `ElementCollection`); A mapping, containing file names as keys and an `Element` as data. Multiple files will be produced from the different datas, the result is a zip file containing them. In the first case, no output file name is specified and the server will name it "file0". +46 server (Server): Server to be used for this print job. +47 template (Resource): Template to use for this print job. +48 output_config (OutputConfig, optional): Output configuration to be used for this print job. Defaults to `OutputConfig`(). +49 subtemplates (Dict[str, Resource], optional): Subtemplates for this print job, accessible (in docx) through `{?include subtemplate_dict_key}`. Defaults to {}. +50 prepend_files (List[Resource], optional): Files to prepend to the output file. Defaults to []. +51 append_files (List[Resource], optional): Files to append to the output file. Defaults to []. +52 cop_verbose (bool, optional): Whether or not verbose mode should be activated. Defaults to False. +53 """ +54 +55 self.data: Union[Element, Mapping[str, Element], RESTSource] = data +56 self.server: Server = server +57 self.output_config: OutputConfig = output_config +58 self.template: Resource = template +59 self.subtemplates: Dict[str, Resource] = subtemplates +60 self.prepend_files: List[Resource] = prepend_files +61 self.append_files: List[Resource] = append_files +62 self.cop_verbose: bool = cop_verbose +
-
-
-
View Source
-def __init__(self, - data: Union[Element, Mapping[str, Element], RESTSource], - server: Server, - template: Resource = None, - output_config: OutputConfig = OutputConfig(), - subtemplates: Dict[str, Resource] = {}, - prepend_files: List[Resource] = [], - append_files: List[Resource] = [], - cop_verbose: bool = False): - """ - Args: - data (Union[Element, Mapping[str, Element], RESTSource]): This is either: An `Element` (e.g. an `ElementCollection`); A mapping, containing file names as keys and an `Element` as data. Multiple files will be produced from the different datas, the result is a zip file containing them. In the first case, no output file name is specified and the server will name it "file0". - server (Server): Server to be used for this print job. - template (Resource): Template to use for this print job. - output_config (OutputConfig, optional): Output configuration to be used for this print job. Defaults to `OutputConfig`(). - subtemplates (Dict[str, Resource], optional): Subtemplates for this print job, accessible (in docx) through `{?include subtemplate_dict_key}`. Defaults to {}. - prepend_files (List[Resource], optional): Files to prepend to the output file. Defaults to []. - append_files (List[Resource], optional): Files to append to the output file. Defaults to []. - cop_verbose (bool, optional): Whether or not verbose mode should be activated. Defaults to False. - """ - - self.data: Union[Element, Mapping[str, Element], RESTSource] = data - self.server: Server = server - self.output_config: OutputConfig = output_config - self.template: Resource = template - self.subtemplates: Dict[str, Resource] = subtemplates - self.prepend_files: List[Resource] = prepend_files - self.append_files: List[Resource] = append_files - self.cop_verbose: bool = cop_verbose -
Args:
data (Union[Element, Mapping[str, Element], RESTSource]): This is either: An Element (e.g. an ElementCollection); A mapping, containing file names as keys and an Element as data. Multiple files will be produced from the different datas, the result is a zip file containing them. In the first case, no output file name is specified and the server will name it "file0".
@@ -838,26 +650,26 @@
Further information
-
+
+
-
+
+ def
+ execute(self) -> cloudofficeprint.Response:
-
+
+
-
+
View Source
-def execute(self) -> Response: - """Execute this print job. + - Returns: - Response: `Response`-object - """ - self.server._raise_if_unreachable() - return self._handle_response(requests.post(self.server.url, proxies=self.server.config.proxies if self.server.config is not None else None, json=self.as_dict, headers={"Content-type": "application/json"})) -
64 def execute(self) -> Response: +65 """Execute this print job. +66 +67 Returns: +68 Response: `Response`-object +69 """ +70 self.server._raise_if_unreachable() +71 return self._handle_response(requests.post(self.server.url, proxies=self.server.config.proxies if self.server.config is not None else None, json=self.as_dict, headers={"Content-type": "application/json"})) +
Execute this print job.
@@ -868,35 +680,35 @@Further information
-
#
+
+
-
+
+ async def
+ execute_async(self) -> cloudofficeprint.Response:
+
+
-
- async def
- execute_async(self) -> cloudofficeprint.response.Response:
+
+ 73 async def execute_async(self) -> Response: +74 """Async version of `PrintJob.execute` +75 +76 Returns: +77 Response: `Response`-object +78 """ +79 self.server._raise_if_unreachable() +80 return PrintJob._handle_response( +81 await asyncio.get_event_loop().run_in_executor( +82 None, partial( +83 requests.post, +84 self.server.url, +85 proxies=self.server.config.proxies if self.server.config is not None else None, +86 json=self.as_dict +87 ) +88 ) +89 ) +
-
-
-
View Source
-async def execute_async(self) -> Response: - """Async version of `PrintJob.execute` - - Returns: - Response: `Response`-object - """ - self.server._raise_if_unreachable() - return PrintJob._handle_response( - await asyncio.get_event_loop().run_in_executor( - None, partial( - requests.post, - self.server.url, - proxies=self.server.config.proxies if self.server.config is not None else None, - json=self.as_dict - ) - ) - ) -
Async version of PrintJob.execute
Further information
-
-
#
+
+
+
+
+
+
- @staticmethod
- @staticmethod
+ def
+ execute_full_json( json_data: str, server: cloudofficeprint.config.server.Server) -> cloudofficeprint.Response:
- def
- execute_full_json(
- json_data: str,
- server: cloudofficeprint.config.server.Server
-) -> cloudofficeprint.response.Response:
-
-
+
View Source
-@staticmethod - def execute_full_json(json_data: str, server: Server) -> Response: - """If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server. - - Args: - json_data (str): full JSON data that needs to be sent to a Cloud Office Print server - server (Server): `Server`-object - - Returns: - Response: `Response`-object - """ - server._raise_if_unreachable() - return PrintJob._handle_response(requests.post(server.url, proxies=server.config.proxies if server.config is not None else None, data=json_data, headers={"Content-type": "application/json"})) -
91 @staticmethod + 92 def execute_full_json(json_data: str, server: Server) -> Response: + 93 """If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server. + 94 + 95 Args: + 96 json_data (str): full JSON data that needs to be sent to a Cloud Office Print server + 97 server (Server): `Server`-object + 98 + 99 Returns: +100 Response: `Response`-object +101 """ +102 server._raise_if_unreachable() +103 return PrintJob._handle_response(requests.post(server.url, proxies=server.config.proxies if server.config is not None else None, data=json_data, headers={"Content-type": "application/json"})) +
If you already have the JSON to be sent to the server (not just the data, but the entire JSON body including your API key and template), this package will wrap the request to the server.
@@ -950,45 +759,42 @@Further information
-
#
+
+
-
+
+
+ @staticmethod
+
+ async def
+ execute_full_json_async( json_data: str, server: cloudofficeprint.config.server.Server) -> cloudofficeprint.Response:
- @staticmethod
+
- async def
- execute_full_json_async(
- json_data: str,
- server: cloudofficeprint.config.server.Server
-) -> cloudofficeprint.response.Response:
105 @staticmethod +106 async def execute_full_json_async(json_data: str, server: Server) -> Response: +107 """Async version of `Printjob.execute_full_json` +108 +109 Args: +110 json_data (str): full JSON data that needs to be sent to a Cloud Office Print server +111 server (Server): `Server`-object +112 +113 Returns: +114 Response: `Response`-object +115 """ +116 server._raise_if_unreachable() +117 return PrintJob._handle_response( +118 await asyncio.get_event_loop().run_in_executor( +119 None, partial( +120 requests.post, +121 server.url, +122 proxies=server.config.proxies if server.config is not None else None, +123 data=json_data, +124 headers={"Content-type": "application/json"} +125 ) +126 ) +127 ) +
-
-
-
View Source
-@staticmethod - async def execute_full_json_async(json_data: str, server: Server) -> Response: - """Async version of `Printjob.execute_full_json` - - Args: - json_data (str): full JSON data that needs to be sent to a Cloud Office Print server - server (Server): `Server`-object - - Returns: - Response: `Response`-object - """ - server._raise_if_unreachable() - return PrintJob._handle_response( - await asyncio.get_event_loop().run_in_executor( - None, partial( - requests.post, - server.url, - proxies=server.config.proxies if server.config is not None else None, - data=json_data, - headers={"Content-type": "application/json"} - ) - ) - ) -
Async version of Printjob.execute_full_json
Further information
-
#
+
+ json: str
- json: str
+
-
+
+
JSON equivalent of the dict representation of this print job.
This representation is isomorphic to the dict representation Printjob.as_dict.
Further information
-
#
+
-
-
-
+ as_dict: Dict
- as_dict: Dict
+
-
+
+
Return the dict representation of this print job.
Returns: @@ -1033,205 +843,204 @@
Further information
-
+
+
-
View Source
-class Resource(ABC): - """The abstract base class for the resources.""" - - def __init__(self, data: Union[str, bytes] = None, filetype: str = None): - """ - Args: - data (Union[str, bytes], optional): the data for this resource. Defaults to None. - filetype (str, optional): the file type of this resource. Defaults to None. - """ - self._data: Union[str, bytes] = data - self.filetype: str = filetype - - @property - def mimetype(self) -> str: - """Resource type as a mime type. - - Returns: - str: resource type as a mime type - """ - return type_utils.extension_to_mimetype(self.filetype) - - @property - def data(self) -> Union[str, bytes]: - """The data contained in this Resource. - - Returns: - Union[str, bytes]: the data contained in this Resource - """ - return self._data - - @property - def template_json(self) -> str: - """Get the JSON representation when used as a template. - - Returns: - str: JSON representation of this resource as a template - """ - return json.dumps(self.template_dict) - - @property - @abstractmethod - def template_dict(self) -> Dict: - """This Resource object as a dict object for use as a template. - This dict and the template JSON representation (`Resource.template_json`) are isomorphic. - - Returns: - Dict: dict representation of this resource as a template - """ - pass - - @property - def secondary_file_json(self) -> str: - """The JSON representation for use as secondary file. - - Returns: - str: JSON representation of this resource as a secondary file - """ - return json.dumps(self.secondary_file_dict) - - @property - @abstractmethod - def secondary_file_dict(self) -> Dict: - """This Resource object as a dict object for use as a secondary file (prepend, append, insert, as subtemplate). - This dict and the "concat file" JSON representation (`Resource.secondary_file_json`) are isomorphic. - - Returns: - Dict: dict representation of this resource as a secondary file - """ - pass - - def __str__(self) -> str: - """Override the string representation of this class to return the template-style json. - - Returns: - str: JSON representation of this resource as a template - """ - return self.template_json - - @staticmethod - def from_base64(base64string: str, filetype: str) -> 'Base64Resource': - """Create a Base64Resource from a base64 string and a file type (extension). - - Args: - base64string (str): base64 encoded string - filetype (str): file type (extension) - - Returns: - Base64Resource: the created Resource - """ - return Base64Resource(base64string, filetype) - - @staticmethod - def from_raw(raw_data: bytes, filetype: str) -> 'RawResource': - """Create a RawResource from raw file data and a file type (extension). - - Args: - raw_data (bytes): raw data as a [bytes-like object](https://docs.python.org/3/glossary.html#term-bytes-like-object) - filetype (str): file type (extension) - - Returns: - RawResource: the created Resource - """ - return RawResource(raw_data, filetype) - - @staticmethod - def from_local_file(local_path: str) -> 'Base64Resource': - """Create a Base64Resource with the contents of a local file. - - Throws IOError if it can't read the file. - The filetype is determined by the extension of the file. - - Args: - local_path (str): path to local file - - Returns: - Base64Resource: the created Resource - """ - base64string: str = file_utils.read_file_as_base64(local_path) - return Base64Resource(base64string, type_utils.path_to_extension(local_path)) - - @staticmethod - def from_server_path(path: str) -> 'ServerPathResource': - """Create a ServerPathResource targeting a file on the server. - - The filetype is determined by the extension of the file. - - Args: - path (str): location of target file on the server - - Returns: - ServerPathResource: the created Resource - """ - return ServerPathResource(path) - - @staticmethod - def from_url(url: str, filetype: str) -> 'URLResource': - """Create an Resource targeting the file at url with given filetype (extension). - - Args: - url (str): file url - filetype (str): file type (extension) - - Returns: - URLResource: the created Resource - """ - return URLResource(url, filetype) + ++ + class + Resource+(abc.ABC): - @staticmethod - def from_html(htmlstring: str, landscape: bool = False) -> 'HTMLResource': - """Create an HTMLResource with html data in plain text. + - Landscape is not supported for prepend/append sources, only for template resources. - - Args: - htmlstring (str): html content - landscape (bool, optional): whether to use the landscape option. Defaults to False. - - Returns: - HTMLResource: the created Resource - """ - return HTMLResource(htmlstring, landscape) -
20class Resource(ABC): + 21 """The abstract base class for the resources.""" + 22 + 23 def __init__(self, data: Union[str, bytes] = None, filetype: str = None): + 24 """ + 25 Args: + 26 data (Union[str, bytes], optional): the data for this resource. Defaults to None. + 27 filetype (str, optional): the file type of this resource. Defaults to None. + 28 """ + 29 self._data: Union[str, bytes] = data + 30 self.filetype: str = filetype + 31 + 32 @property + 33 def mimetype(self) -> str: + 34 """Resource type as a mime type. + 35 + 36 Returns: + 37 str: resource type as a mime type + 38 """ + 39 return type_utils.extension_to_mimetype(self.filetype) + 40 + 41 @property + 42 def data(self) -> Union[str, bytes]: + 43 """The data contained in this Resource. + 44 + 45 Returns: + 46 Union[str, bytes]: the data contained in this Resource + 47 """ + 48 return self._data + 49 + 50 @property + 51 def template_json(self) -> str: + 52 """Get the JSON representation when used as a template. + 53 + 54 Returns: + 55 str: JSON representation of this resource as a template + 56 """ + 57 return json.dumps(self.template_dict) + 58 + 59 @property + 60 @abstractmethod + 61 def template_dict(self) -> Dict: + 62 """This Resource object as a dict object for use as a template. + 63 This dict and the template JSON representation (`Resource.template_json`) are isomorphic. + 64 + 65 Returns: + 66 Dict: dict representation of this resource as a template + 67 """ + 68 pass + 69 + 70 @property + 71 def secondary_file_json(self) -> str: + 72 """The JSON representation for use as secondary file. + 73 + 74 Returns: + 75 str: JSON representation of this resource as a secondary file + 76 """ + 77 return json.dumps(self.secondary_file_dict) + 78 + 79 @property + 80 @abstractmethod + 81 def secondary_file_dict(self) -> Dict: + 82 """This Resource object as a dict object for use as a secondary file (prepend, append, insert, as subtemplate). + 83 This dict and the "concat file" JSON representation (`Resource.secondary_file_json`) are isomorphic. + 84 + 85 Returns: + 86 Dict: dict representation of this resource as a secondary file + 87 """ + 88 pass + 89 + 90 def __str__(self) -> str: + 91 """Override the string representation of this class to return the template-style json. + 92 + 93 Returns: + 94 str: JSON representation of this resource as a template + 95 """ + 96 return self.template_json + 97 + 98 @staticmethod + 99 def from_base64(base64string: str, filetype: str) -> 'Base64Resource': +100 """Create a Base64Resource from a base64 string and a file type (extension). +101 +102 Args: +103 base64string (str): base64 encoded string +104 filetype (str): file type (extension) +105 +106 Returns: +107 Base64Resource: the created Resource +108 """ +109 return Base64Resource(base64string, filetype) +110 +111 @staticmethod +112 def from_raw(raw_data: bytes, filetype: str) -> 'RawResource': +113 """Create a RawResource from raw file data and a file type (extension). +114 +115 Args: +116 raw_data (bytes): raw data as a [bytes-like object](https://docs.python.org/3/glossary.html#term-bytes-like-object) +117 filetype (str): file type (extension) +118 +119 Returns: +120 RawResource: the created Resource +121 """ +122 return RawResource(raw_data, filetype) +123 +124 @staticmethod +125 def from_local_file(local_path: str) -> 'Base64Resource': +126 """Create a Base64Resource with the contents of a local file. +127 +128 Throws IOError if it can't read the file. +129 The filetype is determined by the extension of the file. +130 +131 Args: +132 local_path (str): path to local file +133 +134 Returns: +135 Base64Resource: the created Resource +136 """ +137 base64string: str = file_utils.read_file_as_base64(local_path) +138 return Base64Resource(base64string, type_utils.path_to_extension(local_path)) +139 +140 @staticmethod +141 def from_server_path(path: str) -> 'ServerPathResource': +142 """Create a ServerPathResource targeting a file on the server. +143 +144 The filetype is determined by the extension of the file. +145 +146 Args: +147 path (str): location of target file on the server +148 +149 Returns: +150 ServerPathResource: the created Resource +151 """ +152 return ServerPathResource(path) +153 +154 @staticmethod +155 def from_url(url: str, filetype: str) -> 'URLResource': +156 """Create an Resource targeting the file at url with given filetype (extension). +157 +158 Args: +159 url (str): file url +160 filetype (str): file type (extension) +161 +162 Returns: +163 URLResource: the created Resource +164 """ +165 return URLResource(url, filetype) +166 +167 @staticmethod +168 def from_html(htmlstring: str, landscape: bool = False) -> 'HTMLResource': +169 """Create an HTMLResource with html data in plain text. +170 +171 Landscape is not supported for prepend/append sources, only for template resources. +172 +173 Args: +174 htmlstring (str): html content +175 landscape (bool, optional): whether to use the landscape option. Defaults to False. +176 +177 Returns: +178 HTMLResource: the created Resource +179 """ +180 return HTMLResource(htmlstring, landscape) +
The abstract base class for the resources.
-
-
#
+
+
+
+
+
+ Resource(data: Union[str, bytes] = None, filetype: str = None)
-
- Resource(data: Union[str, bytes] = None, filetype: str = None)
-
+
-
-
+
View Source
-def __init__(self, data: Union[str, bytes] = None, filetype: str = None): - """ - Args: - data (Union[str, bytes], optional): the data for this resource. Defaults to None. - filetype (str, optional): the file type of this resource. Defaults to None. - """ - self._data: Union[str, bytes] = data - self.filetype: str = filetype -
23 def __init__(self, data: Union[str, bytes] = None, filetype: str = None): +24 """ +25 Args: +26 data (Union[str, bytes], optional): the data for this resource. Defaults to None. +27 filetype (str, optional): the file type of this resource. Defaults to None. +28 """ +29 self._data: Union[str, bytes] = data +30 self.filetype: str = filetype +
Args: data (Union[str, bytes], optional): the data for this resource. Defaults to None. @@ -1241,11 +1050,13 @@
Further information
-
#
+
+ mimetype: str
- mimetype: str
+
-
+
+
Resource type as a mime type.
Returns: @@ -1255,11 +1066,13 @@
Further information
-
#
+
+ data: Union[str, bytes]
- data: Union[str, bytes]
+
-
+
+
The data contained in this Resource.
Returns: @@ -1269,11 +1082,13 @@
Further information
-
#
+
+ template_json: str
- template_json: str
+
-
+
+
Get the JSON representation when used as a template.
Returns: @@ -1283,11 +1098,13 @@
Further information
-
#
+
+ template_dict: Dict
- template_dict: Dict
+
-
+
+
This Resource object as a dict object for use as a template.
This dict and the template JSON representation (Resource.template_json) are isomorphic.
Further information
-
#
+
+ secondary_file_json: str
- secondary_file_json: str
+
-
+
+
The JSON representation for use as secondary file.
Returns: @@ -1312,11 +1131,13 @@
Further information
-
#
+
+ secondary_file_dict: Dict
- secondary_file_dict: Dict
+
-
+
+
This Resource object as a dict object for use as a secondary file (prepend, append, insert, as subtemplate).
This dict and the "concat file" JSON representation (Resource.secondary_file_json) are isomorphic.
Further information
-
-
#
-
-
+
+ @staticmethod
+
+
+
+ def
+ from_base64( base64string: str, filetype: str) -> cloudofficeprint.resource.Base64Resource:
- @staticmethod
- def
- from_base64(
- base64string: str,
- filetype: str
-) -> cloudofficeprint.resource.Base64Resource:
-
-
+
View Source
-@staticmethod - def from_base64(base64string: str, filetype: str) -> 'Base64Resource': - """Create a Base64Resource from a base64 string and a file type (extension). + - Args: - base64string (str): base64 encoded string - filetype (str): file type (extension) - - Returns: - Base64Resource: the created Resource - """ - return Base64Resource(base64string, filetype) -
98 @staticmethod + 99 def from_base64(base64string: str, filetype: str) -> 'Base64Resource': +100 """Create a Base64Resource from a base64 string and a file type (extension). +101 +102 Args: +103 base64string (str): base64 encoded string +104 filetype (str): file type (extension) +105 +106 Returns: +107 Base64Resource: the created Resource +108 """ +109 return Base64Resource(base64string, filetype) +
Create a Base64Resource from a base64 string and a file type (extension).
@@ -1369,34 +1187,31 @@Further information
-
-
#
+
+
+
+
+
-
- @staticmethod
- @staticmethod
+ def
+ from_raw(raw_data: bytes, filetype: str) -> cloudofficeprint.resource.RawResource:
- def
- from_raw(
- raw_data: bytes,
- filetype: str
-) -> cloudofficeprint.resource.RawResource:
-
-
+
View Source
-@staticmethod - def from_raw(raw_data: bytes, filetype: str) -> 'RawResource': - """Create a RawResource from raw file data and a file type (extension). + - Args: - raw_data (bytes): raw data as a [bytes-like object](https://docs.python.org/3/glossary.html#term-bytes-like-object) - filetype (str): file type (extension) - - Returns: - RawResource: the created Resource - """ - return RawResource(raw_data, filetype) -
111 @staticmethod +112 def from_raw(raw_data: bytes, filetype: str) -> 'RawResource': +113 """Create a RawResource from raw file data and a file type (extension). +114 +115 Args: +116 raw_data (bytes): raw data as a [bytes-like object](https://docs.python.org/3/glossary.html#term-bytes-like-object) +117 filetype (str): file type (extension) +118 +119 Returns: +120 RawResource: the created Resource +121 """ +122 return RawResource(raw_data, filetype) +
Create a RawResource from raw file data and a file type (extension).
@@ -1411,34 +1226,34 @@Further information
-
-
#
+
+
+
+
+
-
- @staticmethod
- @staticmethod
+ def
+ from_local_file(local_path: str) -> cloudofficeprint.resource.Base64Resource:
- def
- from_local_file(local_path: str) -> cloudofficeprint.resource.Base64Resource:
-
-
+
View Source
-@staticmethod - def from_local_file(local_path: str) -> 'Base64Resource': - """Create a Base64Resource with the contents of a local file. - - Throws IOError if it can't read the file. - The filetype is determined by the extension of the file. - - Args: - local_path (str): path to local file + - Returns: - Base64Resource: the created Resource - """ - base64string: str = file_utils.read_file_as_base64(local_path) - return Base64Resource(base64string, type_utils.path_to_extension(local_path)) -
124 @staticmethod +125 def from_local_file(local_path: str) -> 'Base64Resource': +126 """Create a Base64Resource with the contents of a local file. +127 +128 Throws IOError if it can't read the file. +129 The filetype is determined by the extension of the file. +130 +131 Args: +132 local_path (str): path to local file +133 +134 Returns: +135 Base64Resource: the created Resource +136 """ +137 base64string: str = file_utils.read_file_as_base64(local_path) +138 return Base64Resource(base64string, type_utils.path_to_extension(local_path)) +
Create a Base64Resource with the contents of a local file.
@@ -1455,32 +1270,32 @@Further information
-
-
#
-
-
+
+@staticmethod
-
- def
- from_server_path(path: str) -> cloudofficeprint.resource.ServerPathResource:
-
+
+
+ @staticmethod
-
-
+
View Source
-@staticmethod - def from_server_path(path: str) -> 'ServerPathResource': - """Create a ServerPathResource targeting a file on the server. + def + from_server_path(path: str) -> cloudofficeprint.resource.ServerPathResource: - The filetype is determined by the extension of the file. + - Args: - path (str): location of target file on the server - - Returns: - ServerPathResource: the created Resource - """ - return ServerPathResource(path) -
140 @staticmethod +141 def from_server_path(path: str) -> 'ServerPathResource': +142 """Create a ServerPathResource targeting a file on the server. +143 +144 The filetype is determined by the extension of the file. +145 +146 Args: +147 path (str): location of target file on the server +148 +149 Returns: +150 ServerPathResource: the created Resource +151 """ +152 return ServerPathResource(path) +
Create a ServerPathResource targeting a file on the server.
@@ -1496,31 +1311,31 @@Further information
-
-
#
-
-
+
+@staticmethod
-
- def
- from_url(url: str, filetype: str) -> cloudofficeprint.resource.URLResource:
-
+
+
+ @staticmethod
-
-
+
View Source
-@staticmethod - def from_url(url: str, filetype: str) -> 'URLResource': - """Create an Resource targeting the file at url with given filetype (extension). + def + from_url(url: str, filetype: str) -> cloudofficeprint.resource.URLResource: - Args: - url (str): file url - filetype (str): file type (extension) + - Returns: - URLResource: the created Resource - """ - return URLResource(url, filetype) -
154 @staticmethod +155 def from_url(url: str, filetype: str) -> 'URLResource': +156 """Create an Resource targeting the file at url with given filetype (extension). +157 +158 Args: +159 url (str): file url +160 filetype (str): file type (extension) +161 +162 Returns: +163 URLResource: the created Resource +164 """ +165 return URLResource(url, filetype) +
Create an Resource targeting the file at url with given filetype (extension).
@@ -1535,36 +1350,33 @@Further information
-
-
-
#
-
-
+
+@staticmethod
-
- def
- from_html(
- htmlstring: str,
- landscape: bool = False
-) -> cloudofficeprint.resource.HTMLResource:
-
+
+
+ @staticmethod
-
-
+
View Source
-@staticmethod - def from_html(htmlstring: str, landscape: bool = False) -> 'HTMLResource': - """Create an HTMLResource with html data in plain text. + def + from_html( htmlstring: str, landscape: bool = False) -> cloudofficeprint.resource.HTMLResource: - Landscape is not supported for prepend/append sources, only for template resources. + - Args: - htmlstring (str): html content - landscape (bool, optional): whether to use the landscape option. Defaults to False. - - Returns: - HTMLResource: the created Resource - """ - return HTMLResource(htmlstring, landscape) -
167 @staticmethod +168 def from_html(htmlstring: str, landscape: bool = False) -> 'HTMLResource': +169 """Create an HTMLResource with html data in plain text. +170 +171 Landscape is not supported for prepend/append sources, only for template resources. +172 +173 Args: +174 htmlstring (str): html content +175 landscape (bool, optional): whether to use the landscape option. Defaults to False. +176 +177 Returns: +178 HTMLResource: the created Resource +179 """ +180 return HTMLResource(htmlstring, landscape) +
Create an HTMLResource with html data in plain text.
@@ -1582,101 +1394,100 @@Further information
- #
+
+
-
+
+ class
+ Response:
+
+
-
- class
- Response:
+
+ 11class Response(): +12 """The Response class serves as a container for and interface with the Cloud Office Print server's response to a printjob request. +13 +14 The Cloud Office Print server can also throw an error, in which case you will be dealing with a cloudofficeprint.exceptions.COPError instead of this class. +15 """ +16 +17 def __init__(self, response: requests.Response): +18 """You should never need to construct a Response manually. +19 +20 Args: +21 response (requests.Response): Response object from the requests package +22 """ +23 self._mimetype = response.headers["Content-Type"] +24 self._bytes = response.content +25 +26 @property +27 def mimetype(self) -> str: +28 """Mime type of this response. +29 +30 Returns: +31 str: mime type of this response +32 """ +33 return self._mimetype +34 +35 @property +36 def filetype(self) -> str: +37 """File type (extension) of this response. E.g. "docx". +38 +39 Returns: +40 str: file type of this response +41 """ +42 return type_utils.mimetype_to_extension(self.mimetype) +43 +44 @property +45 def binary(self) -> bytes: +46 """Binary representation of the output file. +47 +48 Response.to_file can be used to output to a file, +49 alternatively, use this property to do something else with the binary data. +50 +51 Returns: +52 bytes: response file as binary +53 """ +54 return self._bytes +55 +56 def to_string(self) -> str: +57 """Return the string representation of this buffer. +58 Useful if the server returns a JSON (e.g. for output_type 'count_tags'). +59 +60 Raises: +61 err: raise error is bytes cannot be decoded in utf-8 +62 +63 Returns: +64 str: string representation of this buffer +65 """ +66 try: +67 return self._bytes.decode('utf-8') +68 except UnicodeDecodeError as err: +69 print("""The method 'to_string()' cannot be called on this object. +70 The server response is probably not a string (e.g. JSON). +71 To get the bytes of the response, use the property 'binary' instead.""") +72 raise err +73 +74 def to_file(self, path: str): +75 """Write the response to a file at the given path without extension. +76 +77 If the given file path does not contain an extension, +78 the correct path is automatically added from the response data. +79 That is how this method is intended to be used. +80 You should only specify the extension in the path if you have some reason to specify the extension manually. +81 +82 Args: +83 path (str): path without extension +84 """ +85 +86 if not splitext(path)[1]: +87 path += "." + self.filetype +88 +89 # open the file in binary ("b") and write ("w") mode +90 outfile = open(path, "wb") +91 outfile.write(self.binary) +92 outfile.close() +
-
-
-
View Source
-class Response(): - """The Response class serves as a container for and interface with the Cloud Office Print server's response to a printjob request. - - The Cloud Office Print server can also throw an error, in which case you will be dealing with a cloudofficeprint.exceptions.COPError instead of this class. - """ - - def __init__(self, response: requests.Response): - """You should never need to construct a Response manually. - - Args: - response (requests.Response): Response object from the requests package - """ - self._mimetype = response.headers["Content-Type"] - self._bytes = response.content - - @property - def mimetype(self) -> str: - """Mime type of this response. - - Returns: - str: mime type of this response - """ - return self._mimetype - - @property - def filetype(self) -> str: - """File type (extension) of this response. E.g. "docx". - - Returns: - str: file type of this response - """ - return type_utils.mimetype_to_extension(self.mimetype) - - @property - def binary(self) -> bytes: - """Binary representation of the output file. - - Response.to_file can be used to output to a file, - alternatively, use this property to do something else with the binary data. - - Returns: - bytes: response file as binary - """ - return self._bytes - - def to_string(self) -> str: - """Return the string representation of this buffer. - Useful if the server returns a JSON (e.g. for output_type 'count_tags'). - - Raises: - err: raise error is bytes cannot be decoded in utf-8 - - Returns: - str: string representation of this buffer - """ - try: - return self._bytes.decode('utf-8') - except UnicodeDecodeError as err: - print("""The method 'to_string()' cannot be called on this object. - The server response is probably not a string (e.g. JSON). - To get the bytes of the response, use the property 'binary' instead.""") - raise err - - def to_file(self, path: str): - """Write the response to a file at the given path without extension. - - If the given file path does not contain an extension, - the correct path is automatically added from the response data. - That is how this method is intended to be used. - You should only specify the extension in the path if you have some reason to specify the extension manually. - - Args: - path (str): path without extension - """ - - if not splitext(path)[1]: - path += "." + self.filetype - - # open the file in binary ("b") and write ("w") mode - outfile = open(path, "wb") - outfile.write(self.binary) - outfile.close() -
The Response class serves as a container for and interface with the Cloud Office Print server's response to a printjob request.
@@ -1685,25 +1496,25 @@Further information
-
-
#
+
+
+
+
+
+ Response(response: requests.models.Response)
-
- Response(response: requests.models.Response)
-
+
-
-
+
View Source
-def __init__(self, response: requests.Response): - """You should never need to construct a Response manually. - - Args: - response (requests.Response): Response object from the requests package - """ - self._mimetype = response.headers["Content-Type"] - self._bytes = response.content -
17 def __init__(self, response: requests.Response): +18 """You should never need to construct a Response manually. +19 +20 Args: +21 response (requests.Response): Response object from the requests package +22 """ +23 self._mimetype = response.headers["Content-Type"] +24 self._bytes = response.content +
You should never need to construct a Response manually.
@@ -1714,11 +1525,13 @@Further information
-
#
+
+ mimetype: str
- mimetype: str
+
-
+
+
Mime type of this response.
Returns: @@ -1728,11 +1541,13 @@
Further information
-
#
+
+ filetype: str
- filetype: str
+
-
+
+
File type (extension) of this response. E.g. "docx".
Returns: @@ -1742,11 +1557,13 @@
Further information
-
#
+
+ binary: bytes
- binary: bytes
+
-
+
+
Binary representation of the output file.
Response.to_file can be used to output to a file, @@ -1759,35 +1576,35 @@
Further information
-
#
+
+
-
+
+ def
+ to_string(self) -> str:
+
+
-
- def
- to_string(self) -> str:
+
+ 56 def to_string(self) -> str: +57 """Return the string representation of this buffer. +58 Useful if the server returns a JSON (e.g. for output_type 'count_tags'). +59 +60 Raises: +61 err: raise error is bytes cannot be decoded in utf-8 +62 +63 Returns: +64 str: string representation of this buffer +65 """ +66 try: +67 return self._bytes.decode('utf-8') +68 except UnicodeDecodeError as err: +69 print("""The method 'to_string()' cannot be called on this object. +70 The server response is probably not a string (e.g. JSON). +71 To get the bytes of the response, use the property 'binary' instead.""") +72 raise err +
-
-
-
View Source
-def to_string(self) -> str: - """Return the string representation of this buffer. - Useful if the server returns a JSON (e.g. for output_type 'count_tags'). - - Raises: - err: raise error is bytes cannot be decoded in utf-8 - - Returns: - str: string representation of this buffer - """ - try: - return self._bytes.decode('utf-8') - except UnicodeDecodeError as err: - print("""The method 'to_string()' cannot be called on this object. - The server response is probably not a string (e.g. JSON). - To get the bytes of the response, use the property 'binary' instead.""") - raise err -
Return the string representation of this buffer. Useful if the server returns a JSON (e.g. for output_type 'count_tags').
@@ -1802,37 +1619,37 @@Further information
-
-
(${doc.bases})`;
+ heading += `:`;
+ break;
+ case "variable":
+ heading = `${doc.fullname}`;
+ if (doc.annotation)
+ heading += `${doc.annotation}`;
+ if (doc.default_value)
+ heading += `${doc.default_value}`;
break;
default:
heading = `${doc.fullname}`;
@@ -1962,7 +1793,7 @@
- ${heading}
+ ${heading}
`;
diff --git a/docs/cloudofficeprint/config.html b/docs/cloudofficeprint/config.html
index 2d7edbb..563f4ff 100644
--- a/docs/cloudofficeprint/config.html
+++ b/docs/cloudofficeprint/config.html
@@ -3,76 +3,79 @@
-
+
cloudofficeprint.config API documentation
-
-
-
-
-
-
-
-
-
+
cloudofficeprint
-
@@ -176,12 +179,26 @@
}
let heading;
- switch (result.doc.type) {
+ switch (result.doc.kind) {
case "function":
- heading = `${doc.funcdef} ${doc.fullname}(${doc.parameters.join(", ")})`;
+ if (doc.fullname.endsWith(".__init__")) {
+ heading = `${doc.fullname.replace(/\.__init__$/, "")}${doc.signature}`;
+ } else {
+ heading = `${doc.funcdef} ${doc.fullname}${doc.signature}`;
+ }
break;
case "class":
heading = `class ${doc.fullname}`;
+ if (doc.bases)
+ heading += `
#
+
+
+
+
+
+ def
+ to_file(self, path: str):
-
- def
- to_file(self, path: str):
-
-
-
-
+
View Source
-def to_file(self, path: str): - """Write the response to a file at the given path without extension. - - If the given file path does not contain an extension, - the correct path is automatically added from the response data. - That is how this method is intended to be used. - You should only specify the extension in the path if you have some reason to specify the extension manually. - - Args: - path (str): path without extension - """ + - if not splitext(path)[1]: - path += "." + self.filetype - - # open the file in binary ("b") and write ("w") mode - outfile = open(path, "wb") - outfile.write(self.binary) - outfile.close() -
74 def to_file(self, path: str): +75 """Write the response to a file at the given path without extension. +76 +77 If the given file path does not contain an extension, +78 the correct path is automatically added from the response data. +79 That is how this method is intended to be used. +80 You should only specify the extension in the path if you have some reason to specify the extension manually. +81 +82 Args: +83 path (str): path without extension +84 """ +85 +86 if not splitext(path)[1]: +87 path += "." + self.filetype +88 +89 # open the file in binary ("b") and write ("w") mode +90 outfile = open(path, "wb") +91 outfile.write(self.binary) +92 outfile.close() +
Write the response to a file at the given path without extension.
@@ -1949,12 +1766,26 @@Further information
} let heading; - switch (result.doc.type) { + switch (result.doc.kind) { case "function": - heading = `${doc.funcdef} ${doc.fullname}(${doc.parameters.join(", ")})`; + if (doc.fullname.endsWith(".__init__")) { + heading = `${doc.fullname.replace(/\.__init__$/, "")}${doc.signature}`; + } else { + heading = `${doc.funcdef} ${doc.fullname}${doc.signature}`; + } break; case "class": heading = `class ${doc.fullname}`; + if (doc.bases) + heading += `Further information
} html += `${doc.doc}
cloudofficeprint.config
Module for output configurations.
The classes under this module encapsulate various configuration options for a print job.
-They are to be used with cloudofficeprint.printjob.PrintJob.
cloudofficeprint.printjob.PrintJob.
-
+
-
View Source
-""" -Module for output configurations. + -The classes under this module encapsulate various configuration options for a print job. -They are to be used with `cloudofficeprint.printjob.PrintJob`. -""" + -from .cloud import * -from .csv import * -from .output import * -from .pdf import * -from .server import * -
1""" + 2Module for output configurations. + 3 + 4The classes under this module encapsulate various configuration options for a print job. + 5They are to be used with `cloudofficeprint.printjob.PrintJob`. + 6""" + 7 + 8from .cloud import * + 9from .csv import * +10from .output import * +11from .pdf import * +12from .server import * +13from .request_option import * +
}
let heading;
- switch (result.doc.type) {
+ switch (result.doc.kind) {
case "function":
- heading = `${doc.funcdef} ${doc.fullname}(${doc.parameters.join(", ")})`;
+ if (doc.fullname.endsWith(".__init__")) {
+ heading = `${doc.fullname.replace(/\.__init__$/, "")}${doc.signature}`;
+ } else {
+ heading = `${doc.funcdef} ${doc.fullname}${doc.signature}`;
+ }
break;
case "class":
heading = `class ${doc.fullname}`;
+ if (doc.bases)
+ heading += `(${doc.bases})`;
+ heading += `:`;
+ break;
+ case "variable":
+ heading = `${doc.fullname}`;
+ if (doc.annotation)
+ heading += `${doc.annotation}`;
+ if (doc.default_value)
+ heading += `${doc.default_value}`;
break;
default:
heading = `${doc.fullname}`;
@@ -189,7 +206,7 @@
}
html += `
- ${heading}
+ ${heading}
${doc.doc}
`;
diff --git a/docs/cloudofficeprint/config/cloud.html b/docs/cloudofficeprint/config/cloud.html
index de57404..f498228 100644
--- a/docs/cloudofficeprint/config/cloud.html
+++ b/docs/cloudofficeprint/config/cloud.html
@@ -2,18 +2,32 @@
-
-
+
+
cloudofficeprint.config.cloud API documentation
-
-
-
-
-
-
+
+
+
+
+
+
-
-
+
+
@@ -22,259 +36,6 @@
Module cloudofficeprint.config.cloud
-
-
-Expand source code
-
-import json
-from typing import Dict, List
-from abc import ABC, abstractmethod
-
-__all__ = [
- "CloudAccessToken",
- "OAuthToken",
- "AWSToken",
- "FTPToken"
-]
-
-SERVICES = [
- "dropbox",
- "gdrive",
- "onedrive",
- "aws_s3",
- "sftp",
- "ftp"
-]
-
-
-class CloudAccessToken(ABC):
- """Abstract base class for classes used to specify cloud access information for outputting to a cloud service."""
-
- def __init__(self, service: str):
- """
- Args:
- service (str): name of the cloud service
-
- Raises:
- ValueError: raise error if the given name for the cloud service is not known
- """
- if not self.is_valid_service(service):
- raise ValueError(f'Unsupported cloud service "{service}".')
- self._service = service
-
- @property
- def service(self) -> str:
- """Returns which cloud service is being used.
-
- Returns:
- str: which cloud service is being used
- """
- return self._service
-
- @service.setter
- def service(self, value: str):
- """Setter for self._service
-
- Args:
- value (str): new value for self._service
-
- Raises:
- ValueError: raise error if the given name for the cloud service is not known
- """
- if not self.is_valid_service(value):
- raise ValueError(f'Unsupported cloud service "{value}".')
- self._service = value
-
- @property
- @abstractmethod
- def as_dict(self) -> Dict:
- """The cloud access token as a dict, for building the JSON.
-
- Returns:
- Dict: dict representation for this cloud access token
- """
- return {
- "output_location": self.service
- }
-
- @property
- def json(self) -> str:
- """The cloud access token as JSON.
-
- Returns:
- str: JSON representation for this cloud access token
- """
- return json.dumps(self.as_dict)
-
- @staticmethod
- def is_valid_service(value: str) -> bool:
- """Check if the given value is a valid service string.
-
- Args:
- value (str): the service to check
-
- Returns:
- bool: whether value is valid
- """
- return value in SERVICES
-
- @staticmethod
- def list_available_services() -> List[str]:
- """List all available services.
-
- Returns:
- List[str]: list of available service strings
- """
- return SERVICES
-
- @staticmethod
- def from_OAuth(service: str, token: str) -> 'OAuthToken':
- """Create a token from an OAuth string and service name.
-
- Args:
- service (str): cloud service
- token (str): OAuth access token
-
- Returns:
- OAuthToken: created token
- """
- return OAuthToken(service, token)
-
- @staticmethod
- def from_AWS(key_id: str, secret_key: str):
- """Create a token from Amazon S3 access key id and secret access key.
-
- Args:
- key_id (str): AWS access key ID
- secret_key (str): AWS secret access key
-
- Returns:
- AWSToken: created token
- """
- return AWSToken(key_id, secret_key)
-
- @staticmethod
- def from_FTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
- """Create a token from FTP info
-
- When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
- The Cloud Office Print server will then fill in default values.
-
- Args:
- host (str): host name or IP address
- port (int, optional): port to use. Defaults to None.
- user (str, optional): user name. Defaults to None.
- password (str, optional): password for user. Defaults to None.
-
- Returns:
- FTPToken: created token
- """
- return FTPToken(host, False, port, user, password)
-
- @staticmethod
- def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
- """Create a token from SFTP info
-
- When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
- The Cloud Office Print server will then fill in default values.
-
- Args:
- host (str): host name or IP address
- port (int, optional): port to use. Defaults to None.
- user (str, optional): user name. Defaults to None.
- password (str, optional): password for user. Defaults to None.
-
- Returns:
- FTPToken: created token
- This is an FTPToken object, with sftp=True passed into the constructor.
- The only difference with FTP is CloudAccessToken.servicename.
- """
- return FTPToken(host, True, port, user, password)
-
-
-class OAuthToken(CloudAccessToken):
- """`CloudAccessToken` to be used for OAuth tokens"""
-
- def __init__(self, service: str, token: str):
- """
- Args:
- service (str): `CloudAccessToken.service`
- token (str): OAuth token
- """
- super().__init__(service)
- self.token: str = token
-
- @property
- def as_dict(self) -> Dict:
- result = super().as_dict
- result.update({
- "cloud_access_token": self.token
- })
- return result
-
-
-class AWSToken(CloudAccessToken):
- """`CloudAccessToken` to be used for AWS tokens"""
-
- def __init__(self, key_id: str, secret_key: str):
- """
- Args:
- key_id (str): AWS access key ID
- secret_key (str): AWS secret key
- """
- super().__init__("aws_s3")
- self.key_id: str = key_id
- self.secret_key: str = secret_key
-
- @property
- def as_dict(self) -> Dict:
- result = super().as_dict
- result.update({
- "cloud_access_token": {
- "access_key": self.key_id,
- "secret_access_key": self.secret_key
- }
- })
- return result
-
-
-class FTPToken(CloudAccessToken):
- """`CloudAccessToken` to be used for FTP/SFTP tokens"""
-
- def __init__(self, host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None):
- """
- Args:
- host (str): Host name or IP address of the FTP/SFTP server.
- sftp (bool, optional): whether to use SFTP (else FTP). Defaults to False.
- port (int, optional): Port number of the FTP/SFTP server. Defaults to None.
- user (str, optional): User name for the FTP/SFTP server. Defaults to None.
- password (str, optional): Password for the user. Defaults to None.
- """
- super().__init__("sftp" if sftp else "ftp")
- self.host: str = host
- self.port: int = port
- self.user: str = user
- self.password: str = password
-
- @property
- def as_dict(self) -> Dict:
- cloud_access_token = {
- "host": self.host
- }
- if self.port is not None:
- cloud_access_token["port"] = self.port
- if self.user is not None:
- cloud_access_token["user"] = self.user
- if self.password is not None:
- cloud_access_token["password"] = self.password
-
- result = super().as_dict
- result.update({
- "cloud_access_token": cloud_access_token
- })
-
- return result
-
@@ -290,14 +51,6 @@ Classes
(key_id:Â str, secret_key:Â str)
-CloudAccessToken to be used for AWS tokens
-Args
-
-key_id : str- AWS access key ID
-secret_key : str- AWS secret key
-
Expand source code
@@ -326,6 +79,14 @@ Args
})
return result
+CloudAccessToken to be used for AWS tokens
+Args
+
+key_id : str- AWS access key ID
+secret_key : str- AWS secret key
+
Ancestors
- CloudAccessToken
@@ -353,17 +114,6 @@ Inherited members
(service:Â str)
-
-
Abstract base class for classes used to specify cloud access information for outputting to a cloud service.
-Args
-
-service : str- name of the cloud service
-
-Raises
-
-ValueError- raise error if the given name for the cloud service is not known
-
Expand source code
@@ -512,6 +262,17 @@ Raises
"""
return FTPToken(host, True, port, user, password)
+Abstract base class for classes used to specify cloud access information for outputting to a cloud service.
+Args
+
+service : str- name of the cloud service
+
+Raises
+
+ValueError- raise error if the given name for the cloud service is not known
+
Ancestors
- abc.ABC
@@ -528,19 +289,6 @@ Static methods
def from_AWS(key_id:Â str, secret_key:Â str)
-
-
Create a token from Amazon S3 access key id and secret access key.
-Args
-
-key_id : str- AWS access key ID
-secret_key : str- AWS secret access key
-
-Returns
-
-AWSToken- created token
-
Expand source code
@@ -558,30 +306,24 @@ Returns
"""
return AWSToken(key_id, secret_key)
-
-
-def from_FTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
--
-
Create a token from FTP info
-When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
-The Cloud Office Print server will then fill in default values.
+Create a token from Amazon S3 access key id and secret access key.
Args
-host : str- host name or IP address
-port : int, optional- port to use. Defaults to None.
-user : str, optional- user name. Defaults to None.
-password : str, optional- password for user. Defaults to None.
+key_id : str- AWS access key ID
+secret_key : str- AWS secret access key
Returns
+
+
+def from_FTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
+-
Expand source code
@@ -604,24 +346,30 @@ Returns
"""
return FTPToken(host, False, port, user, password)
-
-
-def from_OAuth(service: str, token: str) ‑> OAuthToken
--
-
Create a token from an OAuth string and service name.
+Create a token from FTP info
+When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
+The Cloud Office Print server will then fill in default values.
Args
-service : str- cloud service
-token : str- OAuth access token
+host : str- host name or IP address
+port : int, optional- port to use. Defaults to None.
+user : str, optional- user name. Defaults to None.
+password : str, optional- password for user. Defaults to None.
Returns
-OAuthTokenFTPToken- created token
+
+
+def from_OAuth(service: str, token: str) ‑> OAuthToken
+-
Expand source code
@@ -639,32 +387,24 @@ Returns
"""
return OAuthToken(service, token)
-
-
-def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
--
-
Create a token from SFTP info
-When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
-The Cloud Office Print server will then fill in default values.
+Create a token from an OAuth string and service name.
Args
-host : str- host name or IP address
-port : int, optional- port to use. Defaults to None.
-user : str, optional- user name. Defaults to None.
-password : str, optional- password for user. Defaults to None.
+service : str- cloud service
+token : str- OAuth access token
Returns
-FTPToken- created token
-This is an FTPToken object, with sftp=True passed into the constructor.
-The only difference with FTP is CloudAccessToken.servicename.
+OAuthToken- created token
+
+
+def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
+-
Expand source code
@@ -689,22 +429,32 @@ Returns
"""
return FTPToken(host, True, port, user, password)
-
-
-def is_valid_service(value: str) ‑> bool
--
-
Check if the given value is a valid service string.
+Create a token from SFTP info
+When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
+The Cloud Office Print server will then fill in default values.
Args
-value : str- the service to check
+host : str- host name or IP address
+port : int, optional- port to use. Defaults to None.
+user : str, optional- user name. Defaults to None.
+password : str, optional- password for user. Defaults to None.
Returns
-bool- whether value is valid
+FTPToken- created token
+This is an FTPToken object, with sftp=True passed into the constructor.
+The only difference with FTP is CloudAccessToken.servicename.
+
+
+def is_valid_service(value: str) ‑> bool
+-
Expand source code
@@ -721,17 +471,22 @@ Returns
"""
return value in SERVICES
+Check if the given value is a valid service string.
+Args
+
+value : str- the service to check
+
+Returns
+
+bool- whether value is valid
+
def list_available_services() ‑> List[str]
-
-
List all available services.
-Returns
-
-List[str]- list of available service strings
-
Expand source code
@@ -745,18 +500,18 @@ Returns
"""
return SERVICES
+List all available services.
+Returns
+
+List[str]- list of available service strings
+
Instance variables
-var as_dict :Â Dictprop as_dict :Â Dict-
-
The cloud access token as a dict, for building the JSON.
-Returns
-
-Dict- dict representation for this cloud access token
-
Expand source code
@@ -773,15 +528,15 @@ Returns
"output_location": self.service
}
-
-var json :Â str-
-
The cloud access token as JSON.
+The cloud access token as a dict, for building the JSON.
Returns
-str- JSON representation for this cloud access token
+Dict- dict representation for this cloud access token
+
+prop json :Â str-
Expand source code
@@ -795,15 +550,15 @@ Returns
"""
return json.dumps(self.as_dict)
-
-var service :Â str-
-
Returns which cloud service is being used.
+The cloud access token as JSON.
Returns
str- which cloud service is being used
+- JSON representation for this cloud access token
+
+prop service :Â str-
Expand source code
@@ -817,28 +572,20 @@ Returns
"""
return self._service
+Returns which cloud service is being used.
+Returns
+
+str- which cloud service is being used
+
class FTPToken
-(host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None)
+(host:Â str,
sftp: bool = False,
port: int = None,
user: str = None,
password: str = None)
-
-
CloudAccessToken to be used for FTP/SFTP tokens
-Args
-
-host : str- Host name or IP address of the FTP/SFTP server.
-sftp : bool, optional- whether to use SFTP (else FTP). Defaults to False.
-port : int, optional- Port number of the FTP/SFTP server. Defaults to None.
-user : str, optional- User name for the FTP/SFTP server. Defaults to None.
-password : str, optional- Password for the user. Defaults to None.
-
Expand source code
@@ -880,6 +627,20 @@ Args
return result
+CloudAccessToken to be used for FTP/SFTP tokens
+Args
+
+host : str- Host name or IP address of the FTP/SFTP server.
+sftp : bool, optional- whether to use SFTP (else FTP). Defaults to False.
+port : int, optional- Port number of the FTP/SFTP server. Defaults to None.
+user : str, optional- User name for the FTP/SFTP server. Defaults to None.
+password : str, optional- Password for the user. Defaults to None.
+
Ancestors
- CloudAccessToken
@@ -907,14 +668,6 @@ Inherited members
(service:Â str, token:Â str)
-
-
CloudAccessToken to be used for OAuth tokens
-Args
-
-service : strCloudAccessToken.servicetoken : str- OAuth token
-
Expand source code
@@ -939,6 +692,14 @@ Args
})
return result
+CloudAccessToken to be used for OAuth tokens
+Args
+
+service : strCloudAccessToken.servicetoken : str- OAuth token
+
Ancestors
- CloudAccessToken
@@ -965,7 +726,6 @@ Inherited members
-var json :Â str-
-
The JSON representation of these csv options.
-The JSON representation is a direct JSON dump of the dict representation.
-The dict representation is accessed through the as_dict property.
+The dict representation of these csv options.
Returns
-str- JSON representation of these csv options
+Dict- the dict representation of these csv options
+
+prop json :Â str-
Expand source code
@@ -253,6 +187,14 @@ Returns
"""
return json.dumps(self.as_dict)
+The JSON representation of these csv options.
+The JSON representation is a direct JSON dump of the dict representation.
+The dict representation is accessed through the as_dict property.
+Returns
+
+str- JSON representation of these csv options
+
@@ -260,7 +202,6 @@ Returns
}
html += `
- ${heading}
+ ${heading}
${doc.doc}
`;
diff --git a/docs/cloudofficeprint/config/cloud.html b/docs/cloudofficeprint/config/cloud.html
index de57404..f498228 100644
--- a/docs/cloudofficeprint/config/cloud.html
+++ b/docs/cloudofficeprint/config/cloud.html
@@ -2,18 +2,32 @@
-
-
+
+
cloudofficeprint.config.cloud API documentation
-
-
-
-
-
-
+
+
+
+
+
+
-
-
+
+
@@ -22,259 +36,6 @@
Module cloudofficeprint.config.cloud
-
-
-Expand source code
-
-import json
-from typing import Dict, List
-from abc import ABC, abstractmethod
-
-__all__ = [
- "CloudAccessToken",
- "OAuthToken",
- "AWSToken",
- "FTPToken"
-]
-
-SERVICES = [
- "dropbox",
- "gdrive",
- "onedrive",
- "aws_s3",
- "sftp",
- "ftp"
-]
-
-
-class CloudAccessToken(ABC):
- """Abstract base class for classes used to specify cloud access information for outputting to a cloud service."""
-
- def __init__(self, service: str):
- """
- Args:
- service (str): name of the cloud service
-
- Raises:
- ValueError: raise error if the given name for the cloud service is not known
- """
- if not self.is_valid_service(service):
- raise ValueError(f'Unsupported cloud service "{service}".')
- self._service = service
-
- @property
- def service(self) -> str:
- """Returns which cloud service is being used.
-
- Returns:
- str: which cloud service is being used
- """
- return self._service
-
- @service.setter
- def service(self, value: str):
- """Setter for self._service
-
- Args:
- value (str): new value for self._service
-
- Raises:
- ValueError: raise error if the given name for the cloud service is not known
- """
- if not self.is_valid_service(value):
- raise ValueError(f'Unsupported cloud service "{value}".')
- self._service = value
-
- @property
- @abstractmethod
- def as_dict(self) -> Dict:
- """The cloud access token as a dict, for building the JSON.
-
- Returns:
- Dict: dict representation for this cloud access token
- """
- return {
- "output_location": self.service
- }
-
- @property
- def json(self) -> str:
- """The cloud access token as JSON.
-
- Returns:
- str: JSON representation for this cloud access token
- """
- return json.dumps(self.as_dict)
-
- @staticmethod
- def is_valid_service(value: str) -> bool:
- """Check if the given value is a valid service string.
-
- Args:
- value (str): the service to check
-
- Returns:
- bool: whether value is valid
- """
- return value in SERVICES
-
- @staticmethod
- def list_available_services() -> List[str]:
- """List all available services.
-
- Returns:
- List[str]: list of available service strings
- """
- return SERVICES
-
- @staticmethod
- def from_OAuth(service: str, token: str) -> 'OAuthToken':
- """Create a token from an OAuth string and service name.
-
- Args:
- service (str): cloud service
- token (str): OAuth access token
-
- Returns:
- OAuthToken: created token
- """
- return OAuthToken(service, token)
-
- @staticmethod
- def from_AWS(key_id: str, secret_key: str):
- """Create a token from Amazon S3 access key id and secret access key.
-
- Args:
- key_id (str): AWS access key ID
- secret_key (str): AWS secret access key
-
- Returns:
- AWSToken: created token
- """
- return AWSToken(key_id, secret_key)
-
- @staticmethod
- def from_FTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
- """Create a token from FTP info
-
- When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
- The Cloud Office Print server will then fill in default values.
-
- Args:
- host (str): host name or IP address
- port (int, optional): port to use. Defaults to None.
- user (str, optional): user name. Defaults to None.
- password (str, optional): password for user. Defaults to None.
-
- Returns:
- FTPToken: created token
- """
- return FTPToken(host, False, port, user, password)
-
- @staticmethod
- def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
- """Create a token from SFTP info
-
- When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
- The Cloud Office Print server will then fill in default values.
-
- Args:
- host (str): host name or IP address
- port (int, optional): port to use. Defaults to None.
- user (str, optional): user name. Defaults to None.
- password (str, optional): password for user. Defaults to None.
-
- Returns:
- FTPToken: created token
- This is an FTPToken object, with sftp=True passed into the constructor.
- The only difference with FTP is CloudAccessToken.servicename.
- """
- return FTPToken(host, True, port, user, password)
-
-
-class OAuthToken(CloudAccessToken):
- """`CloudAccessToken` to be used for OAuth tokens"""
-
- def __init__(self, service: str, token: str):
- """
- Args:
- service (str): `CloudAccessToken.service`
- token (str): OAuth token
- """
- super().__init__(service)
- self.token: str = token
-
- @property
- def as_dict(self) -> Dict:
- result = super().as_dict
- result.update({
- "cloud_access_token": self.token
- })
- return result
-
-
-class AWSToken(CloudAccessToken):
- """`CloudAccessToken` to be used for AWS tokens"""
-
- def __init__(self, key_id: str, secret_key: str):
- """
- Args:
- key_id (str): AWS access key ID
- secret_key (str): AWS secret key
- """
- super().__init__("aws_s3")
- self.key_id: str = key_id
- self.secret_key: str = secret_key
-
- @property
- def as_dict(self) -> Dict:
- result = super().as_dict
- result.update({
- "cloud_access_token": {
- "access_key": self.key_id,
- "secret_access_key": self.secret_key
- }
- })
- return result
-
-
-class FTPToken(CloudAccessToken):
- """`CloudAccessToken` to be used for FTP/SFTP tokens"""
-
- def __init__(self, host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None):
- """
- Args:
- host (str): Host name or IP address of the FTP/SFTP server.
- sftp (bool, optional): whether to use SFTP (else FTP). Defaults to False.
- port (int, optional): Port number of the FTP/SFTP server. Defaults to None.
- user (str, optional): User name for the FTP/SFTP server. Defaults to None.
- password (str, optional): Password for the user. Defaults to None.
- """
- super().__init__("sftp" if sftp else "ftp")
- self.host: str = host
- self.port: int = port
- self.user: str = user
- self.password: str = password
-
- @property
- def as_dict(self) -> Dict:
- cloud_access_token = {
- "host": self.host
- }
- if self.port is not None:
- cloud_access_token["port"] = self.port
- if self.user is not None:
- cloud_access_token["user"] = self.user
- if self.password is not None:
- cloud_access_token["password"] = self.password
-
- result = super().as_dict
- result.update({
- "cloud_access_token": cloud_access_token
- })
-
- return result
-
@@ -290,14 +51,6 @@ Classes
(key_id:Â str, secret_key:Â str)
-CloudAccessToken to be used for AWS tokens
-Args
-
-key_id : str- AWS access key ID
-secret_key : str- AWS secret key
-
Expand source code
@@ -326,6 +79,14 @@ Args
})
return result
+CloudAccessToken to be used for AWS tokens
+Args
+
+key_id : str- AWS access key ID
+secret_key : str- AWS secret key
+
Ancestors
- CloudAccessToken
@@ -353,17 +114,6 @@ Inherited members
(service:Â str)
-
-
Abstract base class for classes used to specify cloud access information for outputting to a cloud service.
-Args
-
-service : str- name of the cloud service
-
-Raises
-
-ValueError- raise error if the given name for the cloud service is not known
-
Expand source code
@@ -512,6 +262,17 @@ Raises
"""
return FTPToken(host, True, port, user, password)
+Abstract base class for classes used to specify cloud access information for outputting to a cloud service.
+Args
+
+service : str- name of the cloud service
+
+Raises
+
+ValueError- raise error if the given name for the cloud service is not known
+
Ancestors
- abc.ABC
@@ -528,19 +289,6 @@ Static methods
def from_AWS(key_id:Â str, secret_key:Â str)
-
-
Create a token from Amazon S3 access key id and secret access key.
-Args
-
-key_id : str- AWS access key ID
-secret_key : str- AWS secret access key
-
-Returns
-
-AWSToken- created token
-
Expand source code
@@ -558,30 +306,24 @@ Returns
"""
return AWSToken(key_id, secret_key)
-
-
-def from_FTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
--
-
Create a token from FTP info
-When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
-The Cloud Office Print server will then fill in default values.
+Create a token from Amazon S3 access key id and secret access key.
Args
-host : str- host name or IP address
-port : int, optional- port to use. Defaults to None.
-user : str, optional- user name. Defaults to None.
-password : str, optional- password for user. Defaults to None.
+key_id : str- AWS access key ID
+secret_key : str- AWS secret access key
Returns
+
+
+def from_FTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
+-
Expand source code
@@ -604,24 +346,30 @@ Returns
"""
return FTPToken(host, False, port, user, password)
-
-
-def from_OAuth(service: str, token: str) ‑> OAuthToken
--
-
Create a token from an OAuth string and service name.
+Create a token from FTP info
+When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
+The Cloud Office Print server will then fill in default values.
Args
-service : str- cloud service
-token : str- OAuth access token
+host : str- host name or IP address
+port : int, optional- port to use. Defaults to None.
+user : str, optional- user name. Defaults to None.
+password : str, optional- password for user. Defaults to None.
Returns
-OAuthTokenFTPToken- created token
+
+
+def from_OAuth(service: str, token: str) ‑> OAuthToken
+-
Expand source code
@@ -639,32 +387,24 @@ Returns
"""
return OAuthToken(service, token)
-
-
-def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
--
-
Create a token from SFTP info
-When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
-The Cloud Office Print server will then fill in default values.
+Create a token from an OAuth string and service name.
Args
-host : str- host name or IP address
-port : int, optional- port to use. Defaults to None.
-user : str, optional- user name. Defaults to None.
-password : str, optional- password for user. Defaults to None.
+service : str- cloud service
+token : str- OAuth access token
Returns
-FTPToken- created token
-This is an FTPToken object, with sftp=True passed into the constructor.
-The only difference with FTP is CloudAccessToken.servicename.
+OAuthToken- created token
+
+
+def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken
+-
Expand source code
@@ -689,22 +429,32 @@ Returns
"""
return FTPToken(host, True, port, user, password)
-
-
-def is_valid_service(value: str) ‑> bool
--
-
Check if the given value is a valid service string.
+Create a token from SFTP info
+When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
+The Cloud Office Print server will then fill in default values.
Args
-value : str- the service to check
+host : str- host name or IP address
+port : int, optional- port to use. Defaults to None.
+user : str, optional- user name. Defaults to None.
+password : str, optional- password for user. Defaults to None.
Returns
-bool- whether value is valid
+FTPToken- created token
+This is an FTPToken object, with sftp=True passed into the constructor.
+The only difference with FTP is CloudAccessToken.servicename.
+
+
+def is_valid_service(value: str) ‑> bool
+-
Expand source code
@@ -721,17 +471,22 @@ Returns
"""
return value in SERVICES
+Check if the given value is a valid service string.
+Args
+
+value : str- the service to check
+
+Returns
+
+bool- whether value is valid
+
def list_available_services() ‑> List[str]
-
-
List all available services.
-Returns
-
-List[str]- list of available service strings
-
Expand source code
@@ -745,18 +500,18 @@ Returns
"""
return SERVICES
+List all available services.
+Returns
+
+List[str]- list of available service strings
+
Instance variables
-var as_dict :Â Dictprop as_dict :Â Dict-
-
The cloud access token as a dict, for building the JSON.
-Returns
-
-Dict- dict representation for this cloud access token
-
Expand source code
@@ -773,15 +528,15 @@ Returns
"output_location": self.service
}
-
-var json :Â str-
-
The cloud access token as JSON.
+The cloud access token as a dict, for building the JSON.
Returns
-str- JSON representation for this cloud access token
+Dict- dict representation for this cloud access token
+
+prop json :Â str-
Expand source code
@@ -795,15 +550,15 @@ Returns
"""
return json.dumps(self.as_dict)
-
-var service :Â str-
-
Returns which cloud service is being used.
+The cloud access token as JSON.
Returns
str- which cloud service is being used
+- JSON representation for this cloud access token
+
+prop service :Â str-
Expand source code
@@ -817,28 +572,20 @@ Returns
"""
return self._service
+Returns which cloud service is being used.
+Returns
+
+str- which cloud service is being used
+
class FTPToken
-(host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None)
+(host:Â str,
sftp: bool = False,
port: int = None,
user: str = None,
password: str = None)
-
-
CloudAccessToken to be used for FTP/SFTP tokens
-Args
-
-host : str- Host name or IP address of the FTP/SFTP server.
-sftp : bool, optional- whether to use SFTP (else FTP). Defaults to False.
-port : int, optional- Port number of the FTP/SFTP server. Defaults to None.
-user : str, optional- User name for the FTP/SFTP server. Defaults to None.
-password : str, optional- Password for the user. Defaults to None.
-
Expand source code
@@ -880,6 +627,20 @@ Args
return result
+CloudAccessToken to be used for FTP/SFTP tokens
+Args
+
+host : str- Host name or IP address of the FTP/SFTP server.
+sftp : bool, optional- whether to use SFTP (else FTP). Defaults to False.
+port : int, optional- Port number of the FTP/SFTP server. Defaults to None.
+user : str, optional- User name for the FTP/SFTP server. Defaults to None.
+password : str, optional- Password for the user. Defaults to None.
+
Ancestors
- CloudAccessToken
@@ -907,14 +668,6 @@ Inherited members
(service:Â str, token:Â str)
-
-
CloudAccessToken to be used for OAuth tokens
-Args
-
-service : strCloudAccessToken.servicetoken : str- OAuth token
-
Expand source code
@@ -939,6 +692,14 @@ Args
})
return result
+CloudAccessToken to be used for OAuth tokens
+Args
+
+service : strCloudAccessToken.servicetoken : str- OAuth token
+
Ancestors
- CloudAccessToken
@@ -965,7 +726,6 @@ Inherited members
-var json :Â str-
-
The JSON representation of these csv options.
-The JSON representation is a direct JSON dump of the dict representation.
-The dict representation is accessed through the as_dict property.
+The dict representation of these csv options.
Returns
-str- JSON representation of these csv options
+Dict- the dict representation of these csv options
+
+prop json :Â str-
Expand source code
@@ -253,6 +187,14 @@ Returns
"""
return json.dumps(self.as_dict)
+The JSON representation of these csv options.
+The JSON representation is a direct JSON dump of the dict representation.
+The dict representation is accessed through the as_dict property.
+Returns
+
+str- JSON representation of these csv options
+
@@ -260,7 +202,6 @@ Returns
${doc.doc}
Module cloudofficeprint.config.cloud
-
-Expand source code -
-import json
-from typing import Dict, List
-from abc import ABC, abstractmethod
-
-__all__ = [
- "CloudAccessToken",
- "OAuthToken",
- "AWSToken",
- "FTPToken"
-]
-
-SERVICES = [
- "dropbox",
- "gdrive",
- "onedrive",
- "aws_s3",
- "sftp",
- "ftp"
-]
-
-
-class CloudAccessToken(ABC):
- """Abstract base class for classes used to specify cloud access information for outputting to a cloud service."""
-
- def __init__(self, service: str):
- """
- Args:
- service (str): name of the cloud service
-
- Raises:
- ValueError: raise error if the given name for the cloud service is not known
- """
- if not self.is_valid_service(service):
- raise ValueError(f'Unsupported cloud service "{service}".')
- self._service = service
-
- @property
- def service(self) -> str:
- """Returns which cloud service is being used.
-
- Returns:
- str: which cloud service is being used
- """
- return self._service
-
- @service.setter
- def service(self, value: str):
- """Setter for self._service
-
- Args:
- value (str): new value for self._service
-
- Raises:
- ValueError: raise error if the given name for the cloud service is not known
- """
- if not self.is_valid_service(value):
- raise ValueError(f'Unsupported cloud service "{value}".')
- self._service = value
-
- @property
- @abstractmethod
- def as_dict(self) -> Dict:
- """The cloud access token as a dict, for building the JSON.
-
- Returns:
- Dict: dict representation for this cloud access token
- """
- return {
- "output_location": self.service
- }
-
- @property
- def json(self) -> str:
- """The cloud access token as JSON.
-
- Returns:
- str: JSON representation for this cloud access token
- """
- return json.dumps(self.as_dict)
-
- @staticmethod
- def is_valid_service(value: str) -> bool:
- """Check if the given value is a valid service string.
-
- Args:
- value (str): the service to check
-
- Returns:
- bool: whether value is valid
- """
- return value in SERVICES
-
- @staticmethod
- def list_available_services() -> List[str]:
- """List all available services.
-
- Returns:
- List[str]: list of available service strings
- """
- return SERVICES
-
- @staticmethod
- def from_OAuth(service: str, token: str) -> 'OAuthToken':
- """Create a token from an OAuth string and service name.
-
- Args:
- service (str): cloud service
- token (str): OAuth access token
-
- Returns:
- OAuthToken: created token
- """
- return OAuthToken(service, token)
-
- @staticmethod
- def from_AWS(key_id: str, secret_key: str):
- """Create a token from Amazon S3 access key id and secret access key.
-
- Args:
- key_id (str): AWS access key ID
- secret_key (str): AWS secret access key
-
- Returns:
- AWSToken: created token
- """
- return AWSToken(key_id, secret_key)
-
- @staticmethod
- def from_FTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
- """Create a token from FTP info
-
- When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
- The Cloud Office Print server will then fill in default values.
-
- Args:
- host (str): host name or IP address
- port (int, optional): port to use. Defaults to None.
- user (str, optional): user name. Defaults to None.
- password (str, optional): password for user. Defaults to None.
-
- Returns:
- FTPToken: created token
- """
- return FTPToken(host, False, port, user, password)
-
- @staticmethod
- def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) -> 'FTPToken':
- """Create a token from SFTP info
-
- When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server.
- The Cloud Office Print server will then fill in default values.
-
- Args:
- host (str): host name or IP address
- port (int, optional): port to use. Defaults to None.
- user (str, optional): user name. Defaults to None.
- password (str, optional): password for user. Defaults to None.
-
- Returns:
- FTPToken: created token
- This is an FTPToken object, with sftp=True passed into the constructor.
- The only difference with FTP is CloudAccessToken.servicename.
- """
- return FTPToken(host, True, port, user, password)
-
-
-class OAuthToken(CloudAccessToken):
- """`CloudAccessToken` to be used for OAuth tokens"""
-
- def __init__(self, service: str, token: str):
- """
- Args:
- service (str): `CloudAccessToken.service`
- token (str): OAuth token
- """
- super().__init__(service)
- self.token: str = token
-
- @property
- def as_dict(self) -> Dict:
- result = super().as_dict
- result.update({
- "cloud_access_token": self.token
- })
- return result
-
-
-class AWSToken(CloudAccessToken):
- """`CloudAccessToken` to be used for AWS tokens"""
-
- def __init__(self, key_id: str, secret_key: str):
- """
- Args:
- key_id (str): AWS access key ID
- secret_key (str): AWS secret key
- """
- super().__init__("aws_s3")
- self.key_id: str = key_id
- self.secret_key: str = secret_key
-
- @property
- def as_dict(self) -> Dict:
- result = super().as_dict
- result.update({
- "cloud_access_token": {
- "access_key": self.key_id,
- "secret_access_key": self.secret_key
- }
- })
- return result
-
-
-class FTPToken(CloudAccessToken):
- """`CloudAccessToken` to be used for FTP/SFTP tokens"""
-
- def __init__(self, host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None):
- """
- Args:
- host (str): Host name or IP address of the FTP/SFTP server.
- sftp (bool, optional): whether to use SFTP (else FTP). Defaults to False.
- port (int, optional): Port number of the FTP/SFTP server. Defaults to None.
- user (str, optional): User name for the FTP/SFTP server. Defaults to None.
- password (str, optional): Password for the user. Defaults to None.
- """
- super().__init__("sftp" if sftp else "ftp")
- self.host: str = host
- self.port: int = port
- self.user: str = user
- self.password: str = password
-
- @property
- def as_dict(self) -> Dict:
- cloud_access_token = {
- "host": self.host
- }
- if self.port is not None:
- cloud_access_token["port"] = self.port
- if self.user is not None:
- cloud_access_token["user"] = self.user
- if self.password is not None:
- cloud_access_token["password"] = self.password
-
- result = super().as_dict
- result.update({
- "cloud_access_token": cloud_access_token
- })
-
- return resultClasses
(key_id:Â str, secret_key:Â str)CloudAccessToken to be used for AWS tokens
Args
--
-
key_id:str
-- AWS access key ID -
secret_key:str
-- AWS secret key -
Expand source code
@@ -326,6 +79,14 @@ Args
})
return result
CloudAccessToken to be used for AWS tokens
Args
+-
+
key_id:str
+- AWS access key ID +
secret_key:str
+- AWS secret key +
Ancestors
- CloudAccessToken @@ -353,17 +114,6 @@
-
-
Abstract base class for classes used to specify cloud access information for outputting to a cloud service.
-Args
--
-
service:str
-- name of the cloud service -
Raises
--
-
ValueError
-- raise error if the given name for the cloud service is not known -
+Expand source code @@ -512,6 +262,17 @@
Raises
""" return FTPToken(host, True, port, user, password)Abstract base class for classes used to specify cloud access information for outputting to a cloud service.
+Args
+-
+
service:str
+- name of the cloud service +
Raises
+-
+
ValueError
+- raise error if the given name for the cloud service is not known +
Ancestors
- abc.ABC @@ -528,19 +289,6 @@
-
-
Create a token from Amazon S3 access key id and secret access key.
-Args
--
-
key_id:str
-- AWS access key ID -
secret_key:str
-- AWS secret access key -
Returns
--
-
AWSToken
-- created token -
-Expand source code @@ -558,30 +306,24 @@
Returns
""" return AWSToken(key_id, secret_key)
- -def from_FTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken -
--
-
Create a token from FTP info
-When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. -The Cloud Office Print server will then fill in default values.
++ +Create a token from Amazon S3 access key id and secret access key.
Args
-
-
host:str
-- host name or IP address -
port:int, optional
-- port to use. Defaults to None. -
user:str, optional
-- user name. Defaults to None. -
password:str, optional
-- password for user. Defaults to None. +
key_id:str
+- AWS access key ID +
secret_key:str
+- AWS secret access key
Returns
+def from_FTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken +Expand source code @@ -604,24 +346,30 @@
Returns
""" return FTPToken(host, False, port, user, password)-def from_OAuth(service: str, token: str) ‑> OAuthToken -- -
Create a token from an OAuth string and service name.
++ +Create a token from FTP info
+When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. +The Cloud Office Print server will then fill in default values.
Args
-
-
service:str
-- cloud service -
token:str
-- OAuth access token +
host:str
+- host name or IP address +
port:int, optional
+- port to use. Defaults to None. +
user:str, optional
+- user name. Defaults to None. +
password:str, optional
+- password for user. Defaults to None.
Returns
-
-
OAuthToken
+FTPToken- created token
+def from_OAuth(service: str, token: str) ‑> OAuthToken +Expand source code @@ -639,32 +387,24 @@
Returns
""" return OAuthToken(service, token)-def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken -- -
Create a token from SFTP info
-When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. -The Cloud Office Print server will then fill in default values.
++ +Create a token from an OAuth string and service name.
Args
-
-
host:str
-- host name or IP address -
port:int, optional
-- port to use. Defaults to None. -
user:str, optional
-- user name. Defaults to None. -
password:str, optional
-- password for user. Defaults to None. +
service:str
+- cloud service +
token:str
+- OAuth access token
Returns
-
-
FTPToken
-- created token -This is an FTPToken object, with sftp=True passed into the constructor. -The only difference with FTP is CloudAccessToken.servicename. +
OAuthToken
+- created token
+def from_SFTP(host: str, port: int = None, user: str = None, password: str = None) ‑> FTPToken +Expand source code @@ -689,22 +429,32 @@
Returns
""" return FTPToken(host, True, port, user, password)-def is_valid_service(value: str) ‑> bool -- -
Check if the given value is a valid service string.
++ +Create a token from SFTP info
+When an argument is / defaults to None, no data about it is sent to the Cloud Office Print server. +The Cloud Office Print server will then fill in default values.
Args
-
-
value:str
-- the service to check +
host:str
+- host name or IP address +
port:int, optional
+- port to use. Defaults to None. +
user:str, optional
+- user name. Defaults to None. +
password:str, optional
+- password for user. Defaults to None.
Returns
-
-
bool
-- whether value is valid +
FTPToken
+- created token +This is an FTPToken object, with sftp=True passed into the constructor. +The only difference with FTP is CloudAccessToken.servicename.
+def is_valid_service(value: str) ‑> bool ++Expand source code @@ -721,17 +471,22 @@
Returns
""" return value in SERVICESCheck if the given value is a valid service string.
+Args
+-
+
value:str
+- the service to check +
Returns
+-
+
bool
+- whether value is valid +
def list_available_services() ‑> List[str]- -
List all available services.
-Returns
--
-
List[str]
-- list of available service strings -
+Expand source code @@ -745,18 +500,18 @@
Returns
""" return SERVICESList all available services.
+Returns
+-
+
List[str]
+- list of available service strings +
Instance variables
-
-
var as_dict :Â Dict
+prop as_dict :Â Dict-
-
The cloud access token as a dict, for building the JSON.
-Returns
--
-
Dict
-- dict representation for this cloud access token -
-Expand source code @@ -773,15 +528,15 @@
Returns
"output_location": self.service }
- var json :Â str
--
-
The cloud access token as JSON.
++ +The cloud access token as a dict, for building the JSON.
Returns
-
-
str
-- JSON representation for this cloud access token +
Dict
+- dict representation for this cloud access token
prop json :Â strExpand source code @@ -795,15 +550,15 @@
Returns
""" return json.dumps(self.as_dict)var service :Â str- -
Returns which cloud service is being used.
++ +The cloud access token as JSON.
Returns
str
-- which cloud service is being used +
- JSON representation for this cloud access token
prop service :Â str+Expand source code @@ -817,28 +572,20 @@
Returns
""" return self._serviceReturns which cloud service is being used.
+Returns
+-
+
str
+- which cloud service is being used +
class FTPToken -(host: str, sftp: bool = False, port: int = None, user: str = None, password: str = None) +(host: str,
sftp: bool = False,
port: int = None,
user: str = None,
password: str = None)- -
-CloudAccessTokento be used for FTP/SFTP tokensArgs
--
-
host:str
-- Host name or IP address of the FTP/SFTP server. -
sftp:bool, optional
-- whether to use SFTP (else FTP). Defaults to False. -
port:int, optional
-- Port number of the FTP/SFTP server. Defaults to None. -
user:str, optional
-- User name for the FTP/SFTP server. Defaults to None. -
password:str, optional
-- Password for the user. Defaults to None. -
+Expand source code @@ -880,6 +627,20 @@
Args
return result
+CloudAccessTokento be used for FTP/SFTP tokensArgs
+-
+
host:str
+- Host name or IP address of the FTP/SFTP server. +
sftp:bool, optional
+- whether to use SFTP (else FTP). Defaults to False. +
port:int, optional
+- Port number of the FTP/SFTP server. Defaults to None. +
user:str, optional
+- User name for the FTP/SFTP server. Defaults to None. +
password:str, optional
+- Password for the user. Defaults to None. +
Ancestors
- CloudAccessToken @@ -907,14 +668,6 @@
-
-
-CloudAccessTokento be used for OAuth tokensArgs
--
-
service:str
-CloudAccessToken.service
-token:str
-- OAuth token -
+Expand source code @@ -939,6 +692,14 @@
Args
}) return result
+CloudAccessTokento be used for OAuth tokensArgs
+-
+
service:str
+CloudAccessToken.service
+token:str
+- OAuth token +
Ancestors
- CloudAccessToken @@ -965,7 +726,6 @@
Inherited members
- var json :Â str
--
-
The JSON representation of these csv options.
-The JSON representation is a direct JSON dump of the dict representation. -The dict representation is accessed through the
+as_dictproperty.+ +The dict representation of these csv options.
Returns
-
-
str
-- JSON representation of these csv options +
Dict
+- the dict representation of these csv options
prop json :Â strExpand source code @@ -253,6 +187,14 @@
Returns
""" return json.dumps(self.as_dict)The JSON representation of these csv options.
+The JSON representation is a direct JSON dump of the dict representation. +The dict representation is accessed through the
+as_dictproperty.Returns
+-
+
str
+- JSON representation of these csv options +
Returns
Inherited members
(service:Â str, token:Â str)
Static methods
def from_AWS(key_id:Â str, secret_key:Â str)