INSTRUCTION
stringlengths
1
8.43k
RESPONSE
stringlengths
75
104k
Return a single page of results or None if pagination is disabled.
def paginate_dataframe(self, dataframe): """ Return a single page of results, or `None` if pagination is disabled. """ if self.paginator is None: return None return self.paginator.paginate_dataframe(dataframe, self.request, view=self)
parse config return a dict
def parse(self): """parse config, return a dict""" if exists(self.filepath): content = open(self.filepath).read().decode(charset) else: content = "" try: config = toml.loads(content) except toml.TomlSyntaxError: raise ConfigSyntax...
A generator split list lst into number equal size parts. usage::
def chunks(lst, number): """ A generator, split list `lst` into `number` equal size parts. usage:: >>> parts = chunks(range(8),3) >>> parts <generator object chunks at 0xb73bd964> >>> list(parts) [[0, 1, 2], [3, 4, 5], [6, 7]] """ lst_len = len(lst) for...
update nested dict a with another dict b. usage::
def update_nested_dict(a, b): """ update nested dict `a` with another dict b. usage:: >>> a = {'x' : { 'y': 1}} >>> b = {'x' : {'z':2, 'y':3}, 'w': 4} >>> update_nested_dict(a,b) {'x': {'y': 3, 'z': 2}, 'w': 4} """ for k, v in b.iteritems(): if isinstance(v,...
shortcut to render data with template and then write to path. Just add exception catch to renderer. render_to
def render_to(path, template, **data): """shortcut to render data with `template` and then write to `path`. Just add exception catch to `renderer.render_to`""" try: renderer.render_to(path, template, **data) except JinjaTemplateNotFound as e: logger.error(e.__doc__ + ', Template: %r' % t...
text: unicode text to render
def block_code(self, text, lang): """text: unicode text to render""" if not lang: return self._code_no_lexer(text) try: lexer = get_lexer_by_name(lang, stripall=True) except ClassNotFound: # lexer not found, use plain text return self._code_no_lexer...
Parse ascii post source return dict
def parse(self, source): """Parse ascii post source, return dict""" rt, title, title_pic, markdown = libparser.parse(source) if rt == -1: raise SeparatorNotFound elif rt == -2: raise PostTitleNotFound # change to unicode title, title_pic, markdo...
parse post source files name to datetime object
def parse_filename(self, filepath): """parse post source files name to datetime object""" name = os.path.basename(filepath)[:-src_ext_len] try: dt = datetime.strptime(name, "%Y-%m-%d-%H-%M") except ValueError: raise PostNameInvalid return {'name': name, 'd...
run a server binding to port
def run_server(self, port): """run a server binding to port""" try: self.server = MultiThreadedHTTPServer(('0.0.0.0', port), Handler) except socket.error, e: # failed to bind port logger.error(str(e)) sys.exit(1) logger.info("HTTP serve at http://0....
get source files update time
def get_files_stat(self): """get source files' update time""" if not exists(Post.src_dir): logger.error(SourceDirectoryNotFound.__doc__) sys.exit(SourceDirectoryNotFound.exit_code) paths = [] for fn in ls(Post.src_dir): if fn.endswith(src_ext): ...
watch files for changes if changed rebuild blog. this thread will quit if the main process ends
def watch_files(self): """watch files for changes, if changed, rebuild blog. this thread will quit if the main process ends""" try: while 1: sleep(1) # check every 1s try: files_stat = self.get_files_stat() except...
Note: src should be ascii string
def parse(src): """Note: src should be ascii string""" rt = libparser.parse(byref(post), src) return ( rt, string_at(post.title, post.tsz), string_at(post.tpic, post.tpsz), post.body )
Deploy new blog to current directory
def deploy_blog(): """Deploy new blog to current directory""" logger.info(deploy_blog.__doc__) # `rsync -aqu path/to/res/* .` call( 'rsync -aqu ' + join(dirname(__file__), 'res', '*') + ' .', shell=True) logger.success('Done') logger.info('Please edit config.toml to meet your nee...
Touch a new post in src/
def new_post(): """Touch a new post in src/""" logger.info(new_post.__doc__) # make the new post's filename now = datetime.datetime.now() now_s = now.strftime('%Y-%m-%d-%H-%M') filepath = join(Post.src_dir, now_s + src_ext) # check if `src/` exists if not exists(Post.src_dir): lo...
Clean htmls rux built: rm - rf post page index. html
def clean(): """Clean htmls rux built: `rm -rf post page index.html`""" logger.info(clean.__doc__) paths = ['post', 'page', 'index.html'] call(['rm', '-rf'] + paths) logger.success('Done')
Return a BlockContext instance of all the { % block % } tags in the template.
def resolve_blocks(template, context): ''' Return a BlockContext instance of all the {% block %} tags in the template. If template is a string, it will be resolved through get_template ''' try: blocks = context.render_context[BLOCK_CONTEXT_KEY] except KeyError: blocks = context....
Parse a alias: block_name string into separate parts.
def parse_widget_name(widget): ''' Parse a alias:block_name string into separate parts. ''' try: alias, block_name = widget.split(':', 1) except ValueError: raise template.TemplateSyntaxError('widget name must be "alias:block_name" - %s' % widget) return alias, block_name
Temporarily update the context to use the BlockContext for the given alias.
def using(context, alias): ''' Temporarily update the context to use the BlockContext for the given alias. ''' # An empty alias means look in the current widget set. if alias == '': yield context else: try: widgets = context.render_context[WIDGET_CONTEXT_KEY] ...
Find the first matching block in the current block_context
def find_block(context, *names): ''' Find the first matching block in the current block_context ''' block_set = context.render_context[BLOCK_CONTEXT_KEY] for name in names: block = block_set.get_block(name) if block is not None: return block raise template.TemplateSy...
Load a series of widget libraries.
def load_widgets(context, **kwargs): ''' Load a series of widget libraries. ''' _soft = kwargs.pop('_soft', False) try: widgets = context.render_context[WIDGET_CONTEXT_KEY] except KeyError: widgets = context.render_context[WIDGET_CONTEXT_KEY] = {} for alias, template_name i...
Return a list of widget names for the provided field.
def auto_widget(field): '''Return a list of widget names for the provided field.''' # Auto-detect info = { 'widget': field.field.widget.__class__.__name__, 'field': field.field.__class__.__name__, 'name': field.name, } return [ fmt.format(**info) for fmt in (...
Allow reuse of a block within a template.
def reuse(context, block_list, **kwargs): ''' Allow reuse of a block within a template. {% reuse '_myblock' foo=bar %} If passed a list of block names, will use the first that matches: {% reuse list_of_block_names .... %} ''' try: block_context = context.render_context[BLOCK_CONTE...
When dealing with optgroups ensure that the value is properly force_text d.
def display(self): """ When dealing with optgroups, ensure that the value is properly force_text'd. """ if not self.is_group(): return self._display return ((force_text(k), v) for k, v in self._display)
boilerplate
def _list_key(self, key): """ boilerplate """ ret = [] for msg_json in self.client.lrange(key, 0, -1): ret.append(self._fromJSON(msg_json)) return ret
Message instances are namedtuples of type Message. The date field is already serialized in datetime. isoformat ECMA - 262 format
def create_message(self, level, msg_text, extra_tags='', date=None, url=None): """ Message instances are namedtuples of type `Message`. The date field is already serialized in datetime.isoformat ECMA-262 format """ if not date: now = timezone.now() else: ...
Send a message to a list of users without passing through django. contrib. messages
def add_message_for(users, level, message_text, extra_tags='', date=None, url=None, fail_silently=False): """ Send a message to a list of users without passing through `django.contrib.messages` :param users: an iterable containing the recipients of the messages :param level: message level :param me...
Send a message to all users aka broadcast.
def broadcast_message(level, message_text, extra_tags='', date=None, url=None, fail_silently=False): """ Send a message to all users aka broadcast. :param level: message level :param message_text: the string containing the message :param extra_tags: like the Django api, a string containing extra ta...
Mark message instance as read for user. Returns True if the message was unread and thus actually marked as read or False in case it is already read or it does not exist at all.
def mark_read(user, message): """ Mark message instance as read for user. Returns True if the message was `unread` and thus actually marked as `read` or False in case it is already `read` or it does not exist at all. :param user: user instance for the recipient :param message: a Message instanc...
Mark all message instances for a user as read.
def mark_all_read(user): """ Mark all message instances for a user as read. :param user: user instance for the recipient """ BackendClass = stored_messages_settings.STORAGE_BACKEND backend = BackendClass() backend.inbox_purge(user)
Mark all messages as read ( i. e. delete from inbox ) for current logged in user
def mark_all_read(request): """ Mark all messages as read (i.e. delete from inbox) for current logged in user """ from .settings import stored_messages_settings backend = stored_messages_settings.STORAGE_BACKEND() backend.inbox_purge(request.user) return Response({"message": "All messages re...
Mark the message as read ( i. e. delete from inbox )
def read(self, request, pk=None): """ Mark the message as read (i.e. delete from inbox) """ from .settings import stored_messages_settings backend = stored_messages_settings.STORAGE_BACKEND() try: backend.inbox_delete(request.user, pk) except MessageD...
Renders a list of unread stored messages for the current user
def stored_messages_list(context, num_elements=10): """ Renders a list of unread stored messages for the current user """ if "user" in context: user = context["user"] if user.is_authenticated(): qs = Inbox.objects.select_related("message").filter(user=user) return...
Renders a list of unread stored messages for the current user
def stored_messages_count(context): """ Renders a list of unread stored messages for the current user """ if "user" in context: user = context["user"] if user.is_authenticated(): return Inbox.objects.select_related("message").filter(user=user).count()
Renders a list of archived messages for the current user
def stored_messages_archive(context, num_elements=10): """ Renders a list of archived messages for the current user """ if "user" in context: user = context["user"] if user.is_authenticated(): qs = MessageArchive.objects.select_related("message").filter(user=user) ...
Retrieve unread messages for current user both from the inbox and from other storages
def _get(self, *args, **kwargs): """ Retrieve unread messages for current user, both from the inbox and from other storages """ messages, all_retrieved = super(StorageMixin, self)._get(*args, **kwargs) if self.user.is_authenticated(): inbox_messages = self.bac...
If the message level was configured for being stored and request. user is not anonymous save it to the database. Otherwise let some other class handle the message.
def add(self, level, message, extra_tags=''): """ If the message level was configured for being stored and request.user is not anonymous, save it to the database. Otherwise, let some other class handle the message. Notice: controls like checking the message is not empty and the ...
persistent messages are already in the database inside the archive so we can say they re already stored. Here we put them in the inbox or remove from the inbox in case the messages were iterated.
def _store(self, messages, response, *args, **kwargs): """ persistent messages are already in the database inside the 'archive', so we can say they're already "stored". Here we put them in the inbox, or remove from the inbox in case the messages were iterated. messages c...
Like the base class method prepares a list of messages for storage but avoid to do this for models. Message instances.
def _prepare_messages(self, messages): """ Like the base class method, prepares a list of messages for storage but avoid to do this for `models.Message` instances. """ for message in messages: if not self.backend.can_handle(message): message._prepare()
Main entry point for script.
def jocker(test_options=None): """Main entry point for script.""" version = ver_check() options = test_options or docopt(__doc__, version=version) _set_global_verbosity_level(options.get('--verbose')) jocker_lgr.debug(options) jocker_run(options)
initializes a base logger
def init(base_level=DEFAULT_BASE_LOGGING_LEVEL, verbose_level=DEFAULT_VERBOSE_LOGGING_LEVEL, logging_config=None): """initializes a base logger you can use this to init a logger in any of your files. this will use config.py's LOGGER param and logging.dictConfig to configure the logger...
Default converter for the cfg:// protocol.
def cfg_convert(self, value): """Default converter for the cfg:// protocol.""" rest = value m = self.WORD_PATTERN.match(rest) if m is None: raise ValueError("Unable to convert %r" % value) else: rest = rest[m.end():] d = self.config[m.groups()[...
Configure an object with a user - supplied factory.
def configure_custom(self, config): """Configure an object with a user-supplied factory.""" c = config.pop('()') if not hasattr(c, '__call__') and \ hasattr(types, 'ClassType') and isinstance(c, types.ClassType): c = self.resolve(c) props = config.pop('.', Non...
sets the global verbosity level for console and the jocker_lgr logger.
def _set_global_verbosity_level(is_verbose_output=False): """sets the global verbosity level for console and the jocker_lgr logger. :param bool is_verbose_output: should be output be verbose """ global verbose_output # TODO: (IMPRV) only raise exceptions in verbose mode verbose_output = is_verb...
returns a configuration object
def _import_config(config_file): """returns a configuration object :param string config_file: path to config file """ # get config file path jocker_lgr.debug('config file is: {0}'.format(config_file)) # append to path for importing try: jocker_lgr.debug('importing config...') ...
generates a Dockerfile builds an image and pushes it to DockerHub
def execute(varsfile, templatefile, outputfile=None, configfile=None, dryrun=False, build=False, push=False, verbose=False): """generates a Dockerfile, builds an image and pushes it to DockerHub A `Dockerfile` will be generated by Jinja2 according to the `varsfile` imported. If build is true, a...
since the push process outputs a single unicode string consisting of multiple JSON formatted status lines we need to parse it so that it can be read as multiple strings.
def _parse_dumb_push_output(self, string): """since the push process outputs a single unicode string consisting of multiple JSON formatted "status" lines, we need to parse it so that it can be read as multiple strings. This will receive the string as an input, count curly braces and ign...
Uploads an image file to Imgur
def upload_gif(gif): """Uploads an image file to Imgur""" client_id = os.environ.get('IMGUR_API_ID') client_secret = os.environ.get('IMGUR_API_SECRET') if client_id is None or client_secret is None: click.echo('Cannot upload - could not find IMGUR_API_ID or IMGUR_API_SECRET environment variabl...
Return true if the IP address is in dotted decimal notation.
def is_dot(ip): """Return true if the IP address is in dotted decimal notation.""" octets = str(ip).split('.') if len(octets) != 4: return False for i in octets: try: val = int(i) except ValueError: return False if val > 255 or val < 0: ...
Return true if the IP address is in binary notation.
def is_bin(ip): """Return true if the IP address is in binary notation.""" try: ip = str(ip) if len(ip) != 32: return False dec = int(ip, 2) except (TypeError, ValueError): return False if dec > 4294967295 or dec < 0: return False return True
Return true if the IP address is in octal notation.
def is_oct(ip): """Return true if the IP address is in octal notation.""" try: dec = int(str(ip), 8) except (TypeError, ValueError): return False if dec > 0o37777777777 or dec < 0: return False return True
Return true if the IP address is in decimal notation.
def is_dec(ip): """Return true if the IP address is in decimal notation.""" try: dec = int(str(ip)) except ValueError: return False if dec > 4294967295 or dec < 0: return False return True
Function internally used to check if the given netmask is of the specified notation.
def _check_nm(nm, notation): """Function internally used to check if the given netmask is of the specified notation.""" # Convert to decimal, and check if it's in the list of valid netmasks. _NM_CHECK_FUNCT = { NM_DOT: _dot_to_dec, NM_HEX: _hex_to_dec, NM_BIN: _bin_to_dec, ...
Return true if the netmask is in bits notatation.
def is_bits_nm(nm): """Return true if the netmask is in bits notatation.""" try: bits = int(str(nm)) except ValueError: return False if bits > 32 or bits < 0: return False return True
Return true if the netmask is in wildcard bits notatation.
def is_wildcard_nm(nm): """Return true if the netmask is in wildcard bits notatation.""" try: dec = 0xFFFFFFFF - _dot_to_dec(nm, check=True) except ValueError: return False if dec in _NETMASKS_VALUES: return True return False
Dotted decimal notation to decimal conversion.
def _dot_to_dec(ip, check=True): """Dotted decimal notation to decimal conversion.""" if check and not is_dot(ip): raise ValueError('_dot_to_dec: invalid IP: "%s"' % ip) octets = str(ip).split('.') dec = 0 dec |= int(octets[0]) << 24 dec |= int(octets[1]) << 16 dec |= int(octets[2]) ...
Decimal to dotted decimal notation conversion.
def _dec_to_dot(ip): """Decimal to dotted decimal notation conversion.""" first = int((ip >> 24) & 255) second = int((ip >> 16) & 255) third = int((ip >> 8) & 255) fourth = int(ip & 255) return '%d.%d.%d.%d' % (first, second, third, fourth)
Hexadecimal to decimal conversion.
def _hex_to_dec(ip, check=True): """Hexadecimal to decimal conversion.""" if check and not is_hex(ip): raise ValueError('_hex_to_dec: invalid IP: "%s"' % ip) if isinstance(ip, int): ip = hex(ip) return int(str(ip), 16)
Octal to decimal conversion.
def _oct_to_dec(ip, check=True): """Octal to decimal conversion.""" if check and not is_oct(ip): raise ValueError('_oct_to_dec: invalid IP: "%s"' % ip) if isinstance(ip, int): ip = oct(ip) return int(str(ip), 8)
Binary to decimal conversion.
def _bin_to_dec(ip, check=True): """Binary to decimal conversion.""" if check and not is_bin(ip): raise ValueError('_bin_to_dec: invalid IP: "%s"' % ip) if isinstance(ip, int): ip = str(ip) return int(str(ip), 2)
Generate a table to convert a whole byte to binary. This code was taken from the Python Cookbook 2nd edition - O Reilly.
def _BYTES_TO_BITS(): """Generate a table to convert a whole byte to binary. This code was taken from the Python Cookbook, 2nd edition - O'Reilly.""" the_table = 256*[None] bits_per_byte = list(range(7, -1, -1)) for n in range(256): l = n bits = 8*[None] for i in bits_per_byt...
Decimal to binary conversion.
def _dec_to_bin(ip): """Decimal to binary conversion.""" bits = [] while ip: bits.append(_BYTES_TO_BITS[ip & 255]) ip >>= 8 bits.reverse() return ''.join(bits) or 32*'0'
Decimal to decimal ( long ) conversion.
def _dec_to_dec_long(ip, check=True): """Decimal to decimal (long) conversion.""" if check and not is_dec(ip): raise ValueError('_dec_to_dec: invalid IP: "%s"' % ip) return int(str(ip))
Bits to decimal conversion.
def _bits_to_dec(nm, check=True): """Bits to decimal conversion.""" if check and not is_bits_nm(nm): raise ValueError('_bits_to_dec: invalid netmask: "%s"' % nm) bits = int(str(nm)) return VALID_NETMASKS[bits]
Wildcard bits to decimal conversion.
def _wildcard_to_dec(nm, check=False): """Wildcard bits to decimal conversion.""" if check and not is_wildcard_nm(nm): raise ValueError('_wildcard_to_dec: invalid netmask: "%s"' % nm) return 0xFFFFFFFF - _dot_to_dec(nm, check=False)
Internally used to check if an IP/ netmask is in the given notation.
def _is_notation(ip, notation, _isnm): """Internally used to check if an IP/netmask is in the given notation.""" notation_orig = notation notation = _get_notation(notation) if notation not in _CHECK_FUNCT_KEYS: raise ValueError('_is_notation: unkown notation: "%s"' % notation_orig) return _C...
Function internally used to detect the notation of the given IP or netmask.
def _detect(ip, _isnm): """Function internally used to detect the notation of the given IP or netmask.""" ip = str(ip) if len(ip) > 1: if ip[0:2] == '0x': if _CHECK_FUNCT[IP_HEX][_isnm](ip): return IP_HEX elif ip[0] == '0': if _CHECK_FUNCT[IP_OCT][...
Internally used to convert IPs and netmasks to other notations.
def _convert(ip, notation, inotation, _check, _isnm): """Internally used to convert IPs and netmasks to other notations.""" inotation_orig = inotation notation_orig = notation inotation = _get_notation(inotation) notation = _get_notation(notation) if inotation is None: raise ValueError('...
Convert among IP address notations.
def convert(ip, notation=IP_DOT, inotation=IP_UNKNOWN, check=True): """Convert among IP address notations. Given an IP address, this function returns the address in another notation. @param ip: the IP address. @type ip: integers, strings or object with an appropriate __str()__ method. @param ...
Convert a netmask to another notation.
def convert_nm(nm, notation=IP_DOT, inotation=IP_UNKNOWN, check=True): """Convert a netmask to another notation.""" return _convert(nm, notation, inotation, _check=check, _isnm=True)
Set the IP address/ netmask.
def set(self, ip, notation=IP_UNKNOWN): """Set the IP address/netmask.""" self._ip_dec = int(_convert(ip, notation=IP_DEC, inotation=notation, _check=True, _isnm=self._isnm)) self._ip = _convert(self._ip_dec, notation=IP_DOT, inotation=IP_DEC, ...
Return the hexadecimal notation of the address/ netmask.
def get_hex(self): """Return the hexadecimal notation of the address/netmask.""" return _convert(self._ip_dec, notation=IP_HEX, inotation=IP_DEC, _check=False, _isnm=self._isnm)
Return the binary notation of the address/ netmask.
def get_bin(self): """Return the binary notation of the address/netmask.""" return _convert(self._ip_dec, notation=IP_BIN, inotation=IP_DEC, _check=False, _isnm=self._isnm)
Return the octal notation of the address/ netmask.
def get_oct(self): """Return the octal notation of the address/netmask.""" return _convert(self._ip_dec, notation=IP_OCT, inotation=IP_DEC, _check=False, _isnm=self._isnm)
Prepare the item to be compared with this address/ netmask.
def _cmp_prepare(self, other): """Prepare the item to be compared with this address/netmask.""" if isinstance(other, self.__class__): return other._ip_dec elif isinstance(other, int): # NOTE: this hides the fact that "other" can be a non valid IP/nm. return ot...
Sum two IP addresses.
def _add(self, other): """Sum two IP addresses.""" if isinstance(other, self.__class__): sum_ = self._ip_dec + other._ip_dec elif isinstance(other, int): sum_ = self._ip_dec + other else: other = self.__class__(other) sum_ = self._ip_dec + ...
Subtract two IP addresses.
def _sub(self, other): """Subtract two IP addresses.""" if isinstance(other, self.__class__): sub = self._ip_dec - other._ip_dec if isinstance(other, int): sub = self._ip_dec - other else: other = self.__class__(other) sub = self._ip_dec - ...
Return the bits notation of the netmask.
def get_bits(self): """Return the bits notation of the netmask.""" return _convert(self._ip, notation=NM_BITS, inotation=IP_DOT, _check=False, _isnm=self._isnm)
Return the wildcard bits notation of the netmask.
def get_wildcard(self): """Return the wildcard bits notation of the netmask.""" return _convert(self._ip, notation=NM_WILDCARD, inotation=IP_DOT, _check=False, _isnm=self._isnm)
Set the IP address and the netmask.
def set(self, ip, netmask=None): """Set the IP address and the netmask.""" if isinstance(ip, str) and netmask is None: ipnm = ip.split('/') if len(ipnm) != 2: raise ValueError('set: invalid CIDR: "%s"' % ip) ip = ipnm[0] netmask = ipnm[1] ...
Change the current IP.
def set_ip(self, ip): """Change the current IP.""" self.set(ip=ip, netmask=self._nm)
Change the current netmask.
def set_netmask(self, netmask): """Change the current netmask.""" self.set(ip=self._ip, netmask=netmask)
Return true if the given address in amongst the usable addresses or if the given CIDR is contained in this one.
def is_valid_ip(self, ip): """Return true if the given address in amongst the usable addresses, or if the given CIDR is contained in this one.""" if not isinstance(ip, (IPv4Address, CIDR)): if str(ip).find('/') == -1: ip = IPv4Address(ip) else: ...
Upload a file to S3 possibly using the multi - part uploader Return the key uploaded
async def upload_file(self, bucket, file, uploadpath=None, key=None, ContentType=None, **kw): """Upload a file to S3 possibly using the multi-part uploader Return the key uploaded """ is_filename = False if hasattr(file, 'read'): if hasattr(...
Copy a file from one bucket into another
async def copy_storage_object(self, source_bucket, source_key, bucket, key): """Copy a file from one bucket into another """ info = await self.head_object(Bucket=source_bucket, Key=source_key) size = info['ContentLength'] if size > MULTI_PART_SI...
Recursively upload a folder into a backet.
def upload_folder(self, bucket, folder, key=None, skip=None, content_types=None): """Recursively upload a ``folder`` into a backet. :param bucket: bucket where to upload the folder to :param folder: the folder location in the local file system :param key: Optional ...
Coroutine for uploading a single file
async def _upload_file(self, full_path): """Coroutine for uploading a single file """ rel_path = os.path.relpath(full_path, self.folder) key = s3_key(os.path.join(self.key, rel_path)) ct = self.content_types.get(key.split('.')[-1]) with open(full_path, 'rb') as fp: ...
Create a paginator for an operation.: type operation_name: string: param operation_name: The operation name. This is the same name as the method name on the client. For example if the method name is create_foo and you d normally invoke the operation as client. create_foo ( ** kwargs ) if the create_foo operation can be...
def get_paginator(self, operation_name): """Create a paginator for an operation. :type operation_name: string :param operation_name: The operation name. This is the same name as the method name on the client. For example, if the method name is ``create_foo``, and you'd ...
Trigger an event on this channel
async def trigger(self, event, data=None, socket_id=None): '''Trigger an ``event`` on this channel ''' json_data = json.dumps(data, cls=self.pusher.encoder) query_string = self.signed_query(event, json_data, socket_id) signed_path = "%s?%s" % (self.path, query_string) pus...
Connect to a Pusher websocket
async def connect(self): '''Connect to a Pusher websocket ''' if not self._consumer: waiter = self._waiter = asyncio.Future() try: address = self._websocket_host() self.logger.info('Connect to %s', address) self._consumer = ...
Handle websocket incoming messages
def on_message(self, websocket, message): '''Handle websocket incoming messages ''' waiter = self._waiter self._waiter = None encoded = json.loads(message) event = encoded.get('event') channel = encoded.get('channel') data = json.loads(encoded.get('data'))...
URL safe Base64 decode without padding ( = )
def urlsafe_nopadding_b64decode(data): '''URL safe Base64 decode without padding (=)''' padding = len(data) % 4 if padding != 0: padding = 4 - padding padding = '=' * padding data = data + padding return urlsafe_b64decode(data)
Constant time string comparison
def const_equal(str_a, str_b): '''Constant time string comparison''' if len(str_a) != len(str_b): return False result = True for i in range(len(str_a)): result &= (str_a[i] == str_b[i]) return result
Decodes a limited set of HTML entities.
def decode_html_entities(html): """ Decodes a limited set of HTML entities. """ if not html: return html for entity, char in six.iteritems(html_entity_map): html = html.replace(entity, char) return html
Set signature passphrases
def set_signature_passphrases(self, signature_passphrases): '''Set signature passphrases''' self.signature_passphrases = self._update_dict(signature_passphrases, {}, replace_data=True)
Set encryption passphrases
def set_encryption_passphrases(self, encryption_passphrases): '''Set encryption passphrases''' self.encryption_passphrases = self._update_dict(encryption_passphrases, {}, replace_data=True)
Set algorithms used for sealing. Defaults can not be overridden.
def set_algorithms(self, signature=None, encryption=None, serialization=None, compression=None): '''Set algorithms used for sealing. Defaults can not be overridden.''' self.signature_algorithms = \ self._update_dict(signature, self.DEFAULT_SIGNATURE) self.enc...
Get algorithms used for sealing
def get_algorithms(self): '''Get algorithms used for sealing''' return { 'signature': self.signature_algorithms, 'encryption': self.encryption_algorithms, 'serialization': self.serialization_algorithms, 'compression': self.compression_algorithms, ...
Private function for setting options used for sealing
def _set_options(self, options): '''Private function for setting options used for sealing''' if not options: return self.options.copy() options = options.copy() if 'magic' in options: self.set_magic(options['magic']) del(options['magic']) if...
Set magic ( prefix )
def set_magic(self, magic): '''Set magic (prefix)''' if magic is None or isinstance(magic, str): self.magic = magic else: raise TypeError('Invalid value for magic')
Seal data
def seal(self, data, options=None): '''Seal data''' options = self._set_options(options) data = self._serialize_data(data, options) data = self._compress_data(data, options) data = self._encrypt_data(data, options) data = self._add_header(data, options) data = s...