repository_name
stringlengths
7
55
func_path_in_repository
stringlengths
4
223
func_name
stringlengths
1
134
whole_func_string
stringlengths
75
104k
language
stringclasses
1 value
func_code_string
stringlengths
75
104k
func_code_tokens
listlengths
19
28.4k
func_documentation_string
stringlengths
1
46.9k
func_documentation_tokens
listlengths
1
1.97k
split_name
stringclasses
1 value
func_code_url
stringlengths
87
315
karan/HackerNewsAPI
hn/hn.py
Story._get_next_page
def _get_next_page(self, soup, current_page): """ Get the relative url of the next page (The "More" link at the bottom of the page) """ # Get the table with all the comments: if current_page == 1: table = soup.findChildren('table')[3] elif cu...
python
def _get_next_page(self, soup, current_page): """ Get the relative url of the next page (The "More" link at the bottom of the page) """ # Get the table with all the comments: if current_page == 1: table = soup.findChildren('table')[3] elif cu...
[ "def", "_get_next_page", "(", "self", ",", "soup", ",", "current_page", ")", ":", "# Get the table with all the comments:\r", "if", "current_page", "==", "1", ":", "table", "=", "soup", ".", "findChildren", "(", "'table'", ")", "[", "3", "]", "elif", "current_...
Get the relative url of the next page (The "More" link at the bottom of the page)
[ "Get", "the", "relative", "url", "of", "the", "next", "page", "(", "The", "More", "link", "at", "the", "bottom", "of", "the", "page", ")" ]
train
https://github.com/karan/HackerNewsAPI/blob/0e2df2e28f3a6090559eacdefdb99f4d6780ddf5/hn/hn.py#L221-L238
karan/HackerNewsAPI
hn/hn.py
Story._build_comments
def _build_comments(self, soup): """ For the story, builds and returns a list of Comment objects. """ comments = [] current_page = 1 while True: # Get the table holding all comments: if current_page == 1: table = soup.f...
python
def _build_comments(self, soup): """ For the story, builds and returns a list of Comment objects. """ comments = [] current_page = 1 while True: # Get the table holding all comments: if current_page == 1: table = soup.f...
[ "def", "_build_comments", "(", "self", ",", "soup", ")", ":", "comments", "=", "[", "]", "current_page", "=", "1", "while", "True", ":", "# Get the table holding all comments:\r", "if", "current_page", "==", "1", ":", "table", "=", "soup", ".", "findChildren",...
For the story, builds and returns a list of Comment objects.
[ "For", "the", "story", "builds", "and", "returns", "a", "list", "of", "Comment", "objects", "." ]
train
https://github.com/karan/HackerNewsAPI/blob/0e2df2e28f3a6090559eacdefdb99f4d6780ddf5/hn/hn.py#L240-L346
karan/HackerNewsAPI
hn/hn.py
Story.fromid
def fromid(self, item_id): """ Initializes an instance of Story for given item_id. It is assumed that the story referenced by item_id is valid and does not raise any HTTP errors. item_id is an int. """ if not item_id: raise Exception('Need an i...
python
def fromid(self, item_id): """ Initializes an instance of Story for given item_id. It is assumed that the story referenced by item_id is valid and does not raise any HTTP errors. item_id is an int. """ if not item_id: raise Exception('Need an i...
[ "def", "fromid", "(", "self", ",", "item_id", ")", ":", "if", "not", "item_id", ":", "raise", "Exception", "(", "'Need an item_id for a story'", ")", "# get details about a particular story\r", "soup", "=", "get_item_soup", "(", "item_id", ")", "# this post has not be...
Initializes an instance of Story for given item_id. It is assumed that the story referenced by item_id is valid and does not raise any HTTP errors. item_id is an int.
[ "Initializes", "an", "instance", "of", "Story", "for", "given", "item_id", ".", "It", "is", "assumed", "that", "the", "story", "referenced", "by", "item_id", "is", "valid", "and", "does", "not", "raise", "any", "HTTP", "errors", ".", "item_id", "is", "an",...
train
https://github.com/karan/HackerNewsAPI/blob/0e2df2e28f3a6090559eacdefdb99f4d6780ddf5/hn/hn.py#L349-L402
rliebz/whoswho
whoswho/utils.py
compare_name_component
def compare_name_component(list1, list2, settings, use_ratio=False): """ Compare a list of names from a name component based on settings """ if not list1[0] or not list2[0]: not_required = not settings['required'] return not_required * 100 if use_ratio else not_required if len(list1...
python
def compare_name_component(list1, list2, settings, use_ratio=False): """ Compare a list of names from a name component based on settings """ if not list1[0] or not list2[0]: not_required = not settings['required'] return not_required * 100 if use_ratio else not_required if len(list1...
[ "def", "compare_name_component", "(", "list1", ",", "list2", ",", "settings", ",", "use_ratio", "=", "False", ")", ":", "if", "not", "list1", "[", "0", "]", "or", "not", "list2", "[", "0", "]", ":", "not_required", "=", "not", "settings", "[", "'requir...
Compare a list of names from a name component based on settings
[ "Compare", "a", "list", "of", "names", "from", "a", "name", "component", "based", "on", "settings" ]
train
https://github.com/rliebz/whoswho/blob/0c411e418c240fcec6ea0a23d15bd003056c65d0/whoswho/utils.py#L12-L24
rliebz/whoswho
whoswho/utils.py
equate_initial
def equate_initial(name1, name2): """ Evaluates whether names match, or one name is the initial of the other """ if len(name1) == 0 or len(name2) == 0: return False if len(name1) == 1 or len(name2) == 1: return name1[0] == name2[0] return name1 == name2
python
def equate_initial(name1, name2): """ Evaluates whether names match, or one name is the initial of the other """ if len(name1) == 0 or len(name2) == 0: return False if len(name1) == 1 or len(name2) == 1: return name1[0] == name2[0] return name1 == name2
[ "def", "equate_initial", "(", "name1", ",", "name2", ")", ":", "if", "len", "(", "name1", ")", "==", "0", "or", "len", "(", "name2", ")", "==", "0", ":", "return", "False", "if", "len", "(", "name1", ")", "==", "1", "or", "len", "(", "name2", "...
Evaluates whether names match, or one name is the initial of the other
[ "Evaluates", "whether", "names", "match", "or", "one", "name", "is", "the", "initial", "of", "the", "other" ]
train
https://github.com/rliebz/whoswho/blob/0c411e418c240fcec6ea0a23d15bd003056c65d0/whoswho/utils.py#L61-L71
rliebz/whoswho
whoswho/utils.py
equate_prefix
def equate_prefix(name1, name2): """ Evaluates whether names match, or one name prefixes another """ if len(name1) == 0 or len(name2) == 0: return False return name1.startswith(name2) or name2.startswith(name1)
python
def equate_prefix(name1, name2): """ Evaluates whether names match, or one name prefixes another """ if len(name1) == 0 or len(name2) == 0: return False return name1.startswith(name2) or name2.startswith(name1)
[ "def", "equate_prefix", "(", "name1", ",", "name2", ")", ":", "if", "len", "(", "name1", ")", "==", "0", "or", "len", "(", "name2", ")", "==", "0", ":", "return", "False", "return", "name1", ".", "startswith", "(", "name2", ")", "or", "name2", ".",...
Evaluates whether names match, or one name prefixes another
[ "Evaluates", "whether", "names", "match", "or", "one", "name", "prefixes", "another" ]
train
https://github.com/rliebz/whoswho/blob/0c411e418c240fcec6ea0a23d15bd003056c65d0/whoswho/utils.py#L74-L82
rliebz/whoswho
whoswho/utils.py
equate_nickname
def equate_nickname(name1, name2): """ Evaluates whether names match based on common nickname patterns This is not currently used in any name comparison """ # Convert '-ie' and '-y' to the root name nickname_regex = r'(.)\1(y|ie)$' root_regex = r'\1' name1 = re.sub(nickname_regex, root...
python
def equate_nickname(name1, name2): """ Evaluates whether names match based on common nickname patterns This is not currently used in any name comparison """ # Convert '-ie' and '-y' to the root name nickname_regex = r'(.)\1(y|ie)$' root_regex = r'\1' name1 = re.sub(nickname_regex, root...
[ "def", "equate_nickname", "(", "name1", ",", "name2", ")", ":", "# Convert '-ie' and '-y' to the root name", "nickname_regex", "=", "r'(.)\\1(y|ie)$'", "root_regex", "=", "r'\\1'", "name1", "=", "re", ".", "sub", "(", "nickname_regex", ",", "root_regex", ",", "name1...
Evaluates whether names match based on common nickname patterns This is not currently used in any name comparison
[ "Evaluates", "whether", "names", "match", "based", "on", "common", "nickname", "patterns" ]
train
https://github.com/rliebz/whoswho/blob/0c411e418c240fcec6ea0a23d15bd003056c65d0/whoswho/utils.py#L85-L101
rliebz/whoswho
whoswho/utils.py
make_ascii
def make_ascii(word): """ Converts unicode-specific characters to their equivalent ascii """ if sys.version_info < (3, 0, 0): word = unicode(word) else: word = str(word) normalized = unicodedata.normalize('NFKD', word) return normalized.encode('ascii', 'ignore').decode('utf...
python
def make_ascii(word): """ Converts unicode-specific characters to their equivalent ascii """ if sys.version_info < (3, 0, 0): word = unicode(word) else: word = str(word) normalized = unicodedata.normalize('NFKD', word) return normalized.encode('ascii', 'ignore').decode('utf...
[ "def", "make_ascii", "(", "word", ")", ":", "if", "sys", ".", "version_info", "<", "(", "3", ",", "0", ",", "0", ")", ":", "word", "=", "unicode", "(", "word", ")", "else", ":", "word", "=", "str", "(", "word", ")", "normalized", "=", "unicodedat...
Converts unicode-specific characters to their equivalent ascii
[ "Converts", "unicode", "-", "specific", "characters", "to", "their", "equivalent", "ascii" ]
train
https://github.com/rliebz/whoswho/blob/0c411e418c240fcec6ea0a23d15bd003056c65d0/whoswho/utils.py#L104-L115
rliebz/whoswho
whoswho/utils.py
seq_ratio
def seq_ratio(word1, word2): """ Returns sequence match ratio for two words """ raw_ratio = SequenceMatcher(None, word1, word2).ratio() return int(round(100 * raw_ratio))
python
def seq_ratio(word1, word2): """ Returns sequence match ratio for two words """ raw_ratio = SequenceMatcher(None, word1, word2).ratio() return int(round(100 * raw_ratio))
[ "def", "seq_ratio", "(", "word1", ",", "word2", ")", ":", "raw_ratio", "=", "SequenceMatcher", "(", "None", ",", "word1", ",", "word2", ")", ".", "ratio", "(", ")", "return", "int", "(", "round", "(", "100", "*", "raw_ratio", ")", ")" ]
Returns sequence match ratio for two words
[ "Returns", "sequence", "match", "ratio", "for", "two", "words" ]
train
https://github.com/rliebz/whoswho/blob/0c411e418c240fcec6ea0a23d15bd003056c65d0/whoswho/utils.py#L126-L131
rliebz/whoswho
whoswho/utils.py
deep_update_dict
def deep_update_dict(default, options): """ Updates the values in a nested dict, while unspecified values will remain unchanged """ for key in options.keys(): default_setting = default.get(key) new_setting = options.get(key) if isinstance(default_setting, dict): d...
python
def deep_update_dict(default, options): """ Updates the values in a nested dict, while unspecified values will remain unchanged """ for key in options.keys(): default_setting = default.get(key) new_setting = options.get(key) if isinstance(default_setting, dict): d...
[ "def", "deep_update_dict", "(", "default", ",", "options", ")", ":", "for", "key", "in", "options", ".", "keys", "(", ")", ":", "default_setting", "=", "default", ".", "get", "(", "key", ")", "new_setting", "=", "options", ".", "get", "(", "key", ")", ...
Updates the values in a nested dict, while unspecified values will remain unchanged
[ "Updates", "the", "values", "in", "a", "nested", "dict", "while", "unspecified", "values", "will", "remain", "unchanged" ]
train
https://github.com/rliebz/whoswho/blob/0c411e418c240fcec6ea0a23d15bd003056c65d0/whoswho/utils.py#L134-L145
thebigmunch/gmusicapi-scripts
gmusicapi_scripts/gmsync.py
template_to_base_path
def template_to_base_path(template, google_songs): """Get base output path for a list of songs for download.""" if template == os.getcwd() or template == '%suggested%': base_path = os.getcwd() else: template = os.path.abspath(template) song_paths = [template_to_filepath(template, song) for song in google_song...
python
def template_to_base_path(template, google_songs): """Get base output path for a list of songs for download.""" if template == os.getcwd() or template == '%suggested%': base_path = os.getcwd() else: template = os.path.abspath(template) song_paths = [template_to_filepath(template, song) for song in google_song...
[ "def", "template_to_base_path", "(", "template", ",", "google_songs", ")", ":", "if", "template", "==", "os", ".", "getcwd", "(", ")", "or", "template", "==", "'%suggested%'", ":", "base_path", "=", "os", ".", "getcwd", "(", ")", "else", ":", "template", ...
Get base output path for a list of songs for download.
[ "Get", "base", "output", "path", "for", "a", "list", "of", "songs", "for", "download", "." ]
train
https://github.com/thebigmunch/gmusicapi-scripts/blob/5492593db20efb0ea5ad5dcf1b2e1a0e4d0349e8/gmusicapi_scripts/gmsync.py#L74-L84
hosford42/xcs
xcs/_python_bitstrings.py
BitString.random
def random(cls, length, bit_prob=.5): """Create a bit string of the given length, with the probability of each bit being set equal to bit_prob, which defaults to .5. Usage: # Create a random BitString of length 10 with mostly zeros. bits = BitString.random(10, bit_prob=....
python
def random(cls, length, bit_prob=.5): """Create a bit string of the given length, with the probability of each bit being set equal to bit_prob, which defaults to .5. Usage: # Create a random BitString of length 10 with mostly zeros. bits = BitString.random(10, bit_prob=....
[ "def", "random", "(", "cls", ",", "length", ",", "bit_prob", "=", ".5", ")", ":", "assert", "isinstance", "(", "length", ",", "int", ")", "and", "length", ">=", "0", "assert", "isinstance", "(", "bit_prob", ",", "(", "int", ",", "float", ")", ")", ...
Create a bit string of the given length, with the probability of each bit being set equal to bit_prob, which defaults to .5. Usage: # Create a random BitString of length 10 with mostly zeros. bits = BitString.random(10, bit_prob=.1) Arguments: length: An int...
[ "Create", "a", "bit", "string", "of", "the", "given", "length", "with", "the", "probability", "of", "each", "bit", "being", "set", "equal", "to", "bit_prob", "which", "defaults", "to", ".", "5", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/_python_bitstrings.py#L151-L178
hosford42/xcs
xcs/_python_bitstrings.py
BitString.crossover_template
def crossover_template(cls, length, points=2): """Create a crossover template with the given number of points. The crossover template can be used as a mask to crossover two bitstrings of the same length. Usage: assert len(parent1) == len(parent2) template = BitSt...
python
def crossover_template(cls, length, points=2): """Create a crossover template with the given number of points. The crossover template can be used as a mask to crossover two bitstrings of the same length. Usage: assert len(parent1) == len(parent2) template = BitSt...
[ "def", "crossover_template", "(", "cls", ",", "length", ",", "points", "=", "2", ")", ":", "assert", "isinstance", "(", "length", ",", "int", ")", "and", "length", ">=", "0", "assert", "isinstance", "(", "points", ",", "int", ")", "and", "points", ">="...
Create a crossover template with the given number of points. The crossover template can be used as a mask to crossover two bitstrings of the same length. Usage: assert len(parent1) == len(parent2) template = BitString.crossover_template(len(parent1)) inv_temp...
[ "Create", "a", "crossover", "template", "with", "the", "given", "number", "of", "points", ".", "The", "crossover", "template", "can", "be", "used", "as", "a", "mask", "to", "crossover", "two", "bitstrings", "of", "the", "same", "length", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/_python_bitstrings.py#L181-L224
hosford42/xcs
xcs/_python_bitstrings.py
BitString.count
def count(self): """Returns the number of bits set to True in the bit string. Usage: assert BitString('00110').count() == 2 Arguments: None Return: An int, the number of bits with value 1. """ result = 0 bits = self._bits while bi...
python
def count(self): """Returns the number of bits set to True in the bit string. Usage: assert BitString('00110').count() == 2 Arguments: None Return: An int, the number of bits with value 1. """ result = 0 bits = self._bits while bi...
[ "def", "count", "(", "self", ")", ":", "result", "=", "0", "bits", "=", "self", ".", "_bits", "while", "bits", ":", "result", "+=", "bits", "%", "2", "bits", ">>=", "1", "return", "result" ]
Returns the number of bits set to True in the bit string. Usage: assert BitString('00110').count() == 2 Arguments: None Return: An int, the number of bits with value 1.
[ "Returns", "the", "number", "of", "bits", "set", "to", "True", "in", "the", "bit", "string", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/_python_bitstrings.py#L283-L298
ask/carrot
carrot/backends/pyamqplib.py
Connection.drain_events
def drain_events(self, allowed_methods=None, timeout=None): """Wait for an event on any channel.""" return self.wait_multi(self.channels.values(), timeout=timeout)
python
def drain_events(self, allowed_methods=None, timeout=None): """Wait for an event on any channel.""" return self.wait_multi(self.channels.values(), timeout=timeout)
[ "def", "drain_events", "(", "self", ",", "allowed_methods", "=", "None", ",", "timeout", "=", "None", ")", ":", "return", "self", ".", "wait_multi", "(", "self", ".", "channels", ".", "values", "(", ")", ",", "timeout", "=", "timeout", ")" ]
Wait for an event on any channel.
[ "Wait", "for", "an", "event", "on", "any", "channel", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L30-L32
ask/carrot
carrot/backends/pyamqplib.py
Connection.wait_multi
def wait_multi(self, channels, allowed_methods=None, timeout=None): """Wait for an event on a channel.""" chanmap = dict((chan.channel_id, chan) for chan in channels) chanid, method_sig, args, content = self._wait_multiple( chanmap.keys(), allowed_methods, timeout=timeout) ...
python
def wait_multi(self, channels, allowed_methods=None, timeout=None): """Wait for an event on a channel.""" chanmap = dict((chan.channel_id, chan) for chan in channels) chanid, method_sig, args, content = self._wait_multiple( chanmap.keys(), allowed_methods, timeout=timeout) ...
[ "def", "wait_multi", "(", "self", ",", "channels", ",", "allowed_methods", "=", "None", ",", "timeout", "=", "None", ")", ":", "chanmap", "=", "dict", "(", "(", "chan", ".", "channel_id", ",", "chan", ")", "for", "chan", "in", "channels", ")", "chanid"...
Wait for an event on a channel.
[ "Wait", "for", "an", "event", "on", "a", "channel", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L34-L58
ask/carrot
carrot/backends/pyamqplib.py
Backend.establish_connection
def establish_connection(self): """Establish connection to the AMQP broker.""" conninfo = self.connection if not conninfo.hostname: raise KeyError("Missing hostname for AMQP connection.") if conninfo.userid is None: raise KeyError("Missing user id for AMQP connect...
python
def establish_connection(self): """Establish connection to the AMQP broker.""" conninfo = self.connection if not conninfo.hostname: raise KeyError("Missing hostname for AMQP connection.") if conninfo.userid is None: raise KeyError("Missing user id for AMQP connect...
[ "def", "establish_connection", "(", "self", ")", ":", "conninfo", "=", "self", ".", "connection", "if", "not", "conninfo", ".", "hostname", ":", "raise", "KeyError", "(", "\"Missing hostname for AMQP connection.\"", ")", "if", "conninfo", ".", "userid", "is", "N...
Establish connection to the AMQP broker.
[ "Establish", "connection", "to", "the", "AMQP", "broker", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L198-L215
ask/carrot
carrot/backends/pyamqplib.py
Backend.queue_exists
def queue_exists(self, queue): """Check if a queue has been declared. :rtype bool: """ try: self.channel.queue_declare(queue=queue, passive=True) except AMQPChannelException, e: if e.amqp_reply_code == 404: return False raise ...
python
def queue_exists(self, queue): """Check if a queue has been declared. :rtype bool: """ try: self.channel.queue_declare(queue=queue, passive=True) except AMQPChannelException, e: if e.amqp_reply_code == 404: return False raise ...
[ "def", "queue_exists", "(", "self", ",", "queue", ")", ":", "try", ":", "self", ".", "channel", ".", "queue_declare", "(", "queue", "=", "queue", ",", "passive", "=", "True", ")", "except", "AMQPChannelException", ",", "e", ":", "if", "e", ".", "amqp_r...
Check if a queue has been declared. :rtype bool:
[ "Check", "if", "a", "queue", "has", "been", "declared", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L221-L234
ask/carrot
carrot/backends/pyamqplib.py
Backend.queue_delete
def queue_delete(self, queue, if_unused=False, if_empty=False): """Delete queue by name.""" return self.channel.queue_delete(queue, if_unused, if_empty)
python
def queue_delete(self, queue, if_unused=False, if_empty=False): """Delete queue by name.""" return self.channel.queue_delete(queue, if_unused, if_empty)
[ "def", "queue_delete", "(", "self", ",", "queue", ",", "if_unused", "=", "False", ",", "if_empty", "=", "False", ")", ":", "return", "self", ".", "channel", ".", "queue_delete", "(", "queue", ",", "if_unused", ",", "if_empty", ")" ]
Delete queue by name.
[ "Delete", "queue", "by", "name", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L236-L238
ask/carrot
carrot/backends/pyamqplib.py
Backend.queue_declare
def queue_declare(self, queue, durable, exclusive, auto_delete, warn_if_exists=False, arguments=None): """Declare a named queue.""" if warn_if_exists and self.queue_exists(queue): warnings.warn(QueueAlreadyExistsWarning( QueueAlreadyExistsWarning.__doc__)) ...
python
def queue_declare(self, queue, durable, exclusive, auto_delete, warn_if_exists=False, arguments=None): """Declare a named queue.""" if warn_if_exists and self.queue_exists(queue): warnings.warn(QueueAlreadyExistsWarning( QueueAlreadyExistsWarning.__doc__)) ...
[ "def", "queue_declare", "(", "self", ",", "queue", ",", "durable", ",", "exclusive", ",", "auto_delete", ",", "warn_if_exists", "=", "False", ",", "arguments", "=", "None", ")", ":", "if", "warn_if_exists", "and", "self", ".", "queue_exists", "(", "queue", ...
Declare a named queue.
[ "Declare", "a", "named", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L245-L256
ask/carrot
carrot/backends/pyamqplib.py
Backend.exchange_declare
def exchange_declare(self, exchange, type, durable, auto_delete): """Declare an named exchange.""" return self.channel.exchange_declare(exchange=exchange, type=type, durable=durable, ...
python
def exchange_declare(self, exchange, type, durable, auto_delete): """Declare an named exchange.""" return self.channel.exchange_declare(exchange=exchange, type=type, durable=durable, ...
[ "def", "exchange_declare", "(", "self", ",", "exchange", ",", "type", ",", "durable", ",", "auto_delete", ")", ":", "return", "self", ".", "channel", ".", "exchange_declare", "(", "exchange", "=", "exchange", ",", "type", "=", "type", ",", "durable", "=", ...
Declare an named exchange.
[ "Declare", "an", "named", "exchange", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L258-L263
ask/carrot
carrot/backends/pyamqplib.py
Backend.queue_bind
def queue_bind(self, queue, exchange, routing_key, arguments=None): """Bind queue to an exchange using a routing key.""" return self.channel.queue_bind(queue=queue, exchange=exchange, routing_key=routing_key, ...
python
def queue_bind(self, queue, exchange, routing_key, arguments=None): """Bind queue to an exchange using a routing key.""" return self.channel.queue_bind(queue=queue, exchange=exchange, routing_key=routing_key, ...
[ "def", "queue_bind", "(", "self", ",", "queue", ",", "exchange", ",", "routing_key", ",", "arguments", "=", "None", ")", ":", "return", "self", ".", "channel", ".", "queue_bind", "(", "queue", "=", "queue", ",", "exchange", "=", "exchange", ",", "routing...
Bind queue to an exchange using a routing key.
[ "Bind", "queue", "to", "an", "exchange", "using", "a", "routing", "key", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L265-L270
ask/carrot
carrot/backends/pyamqplib.py
Backend.get
def get(self, queue, no_ack=False): """Receive a message from a declared queue by name. :returns: A :class:`Message` object if a message was received, ``None`` otherwise. If ``None`` was returned, it probably means there was no messages waiting on the queue. """ ...
python
def get(self, queue, no_ack=False): """Receive a message from a declared queue by name. :returns: A :class:`Message` object if a message was received, ``None`` otherwise. If ``None`` was returned, it probably means there was no messages waiting on the queue. """ ...
[ "def", "get", "(", "self", ",", "queue", ",", "no_ack", "=", "False", ")", ":", "raw_message", "=", "self", ".", "channel", ".", "basic_get", "(", "queue", ",", "no_ack", "=", "no_ack", ")", "if", "not", "raw_message", ":", "return", "None", "return", ...
Receive a message from a declared queue by name. :returns: A :class:`Message` object if a message was received, ``None`` otherwise. If ``None`` was returned, it probably means there was no messages waiting on the queue.
[ "Receive", "a", "message", "from", "a", "declared", "queue", "by", "name", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L276-L287
ask/carrot
carrot/backends/pyamqplib.py
Backend.consume
def consume(self, limit=None): """Returns an iterator that waits for one message at a time.""" for total_message_count in count(): if limit and total_message_count >= limit: raise StopIteration if not self.channel.is_open: raise StopIteration ...
python
def consume(self, limit=None): """Returns an iterator that waits for one message at a time.""" for total_message_count in count(): if limit and total_message_count >= limit: raise StopIteration if not self.channel.is_open: raise StopIteration ...
[ "def", "consume", "(", "self", ",", "limit", "=", "None", ")", ":", "for", "total_message_count", "in", "count", "(", ")", ":", "if", "limit", "and", "total_message_count", ">=", "limit", ":", "raise", "StopIteration", "if", "not", "self", ".", "channel", ...
Returns an iterator that waits for one message at a time.
[ "Returns", "an", "iterator", "that", "waits", "for", "one", "message", "at", "a", "time", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L298-L308
ask/carrot
carrot/backends/pyamqplib.py
Backend.cancel
def cancel(self, consumer_tag): """Cancel a channel by consumer tag.""" if not self.channel.connection: return self.channel.basic_cancel(consumer_tag)
python
def cancel(self, consumer_tag): """Cancel a channel by consumer tag.""" if not self.channel.connection: return self.channel.basic_cancel(consumer_tag)
[ "def", "cancel", "(", "self", ",", "consumer_tag", ")", ":", "if", "not", "self", ".", "channel", ".", "connection", ":", "return", "self", ".", "channel", ".", "basic_cancel", "(", "consumer_tag", ")" ]
Cancel a channel by consumer tag.
[ "Cancel", "a", "channel", "by", "consumer", "tag", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L310-L314
ask/carrot
carrot/backends/pyamqplib.py
Backend.close
def close(self): """Close the channel if open.""" if self._channel and self._channel.is_open: self._channel.close() self._channel_ref = None
python
def close(self): """Close the channel if open.""" if self._channel and self._channel.is_open: self._channel.close() self._channel_ref = None
[ "def", "close", "(", "self", ")", ":", "if", "self", ".", "_channel", "and", "self", ".", "_channel", ".", "is_open", ":", "self", ".", "_channel", ".", "close", "(", ")", "self", ".", "_channel_ref", "=", "None" ]
Close the channel if open.
[ "Close", "the", "channel", "if", "open", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L316-L320
ask/carrot
carrot/backends/pyamqplib.py
Backend.qos
def qos(self, prefetch_size, prefetch_count, apply_global=False): """Request specific Quality of Service.""" self.channel.basic_qos(prefetch_size, prefetch_count, apply_global)
python
def qos(self, prefetch_size, prefetch_count, apply_global=False): """Request specific Quality of Service.""" self.channel.basic_qos(prefetch_size, prefetch_count, apply_global)
[ "def", "qos", "(", "self", ",", "prefetch_size", ",", "prefetch_count", ",", "apply_global", "=", "False", ")", ":", "self", ".", "channel", ".", "basic_qos", "(", "prefetch_size", ",", "prefetch_count", ",", "apply_global", ")" ]
Request specific Quality of Service.
[ "Request", "specific", "Quality", "of", "Service", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pyamqplib.py#L357-L360
ask/carrot
carrot/backends/librabbitmq.py
Backend.channel
def channel(self): """If no channel exists, a new one is requested.""" if not self._channel: self._channel_ref = weakref.ref(self.connection.get_channel()) return self._channel
python
def channel(self): """If no channel exists, a new one is requested.""" if not self._channel: self._channel_ref = weakref.ref(self.connection.get_channel()) return self._channel
[ "def", "channel", "(", "self", ")", ":", "if", "not", "self", ".", "_channel", ":", "self", ".", "_channel_ref", "=", "weakref", ".", "ref", "(", "self", ".", "connection", ".", "get_channel", "(", ")", ")", "return", "self", ".", "_channel" ]
If no channel exists, a new one is requested.
[ "If", "no", "channel", "exists", "a", "new", "one", "is", "requested", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/librabbitmq.py#L88-L92
ask/carrot
carrot/backends/librabbitmq.py
Backend.establish_connection
def establish_connection(self): """Establish connection to the AMQP broker.""" conninfo = self.connection if not conninfo.hostname: raise KeyError("Missing hostname for AMQP connection.") if conninfo.userid is None: raise KeyError("Missing user id for AMQP connect...
python
def establish_connection(self): """Establish connection to the AMQP broker.""" conninfo = self.connection if not conninfo.hostname: raise KeyError("Missing hostname for AMQP connection.") if conninfo.userid is None: raise KeyError("Missing user id for AMQP connect...
[ "def", "establish_connection", "(", "self", ")", ":", "conninfo", "=", "self", ".", "connection", "if", "not", "conninfo", ".", "hostname", ":", "raise", "KeyError", "(", "\"Missing hostname for AMQP connection.\"", ")", "if", "conninfo", ".", "userid", "is", "N...
Establish connection to the AMQP broker.
[ "Establish", "connection", "to", "the", "AMQP", "broker", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/librabbitmq.py#L94-L110
ask/carrot
carrot/backends/librabbitmq.py
Backend.declare_consumer
def declare_consumer(self, queue, no_ack, callback, consumer_tag, nowait=False): """Declare a consumer.""" return self.channel.basic_consume(queue=queue, no_ack=no_ack, callback=callback, ...
python
def declare_consumer(self, queue, no_ack, callback, consumer_tag, nowait=False): """Declare a consumer.""" return self.channel.basic_consume(queue=queue, no_ack=no_ack, callback=callback, ...
[ "def", "declare_consumer", "(", "self", ",", "queue", ",", "no_ack", ",", "callback", ",", "consumer_tag", ",", "nowait", "=", "False", ")", ":", "return", "self", ".", "channel", ".", "basic_consume", "(", "queue", "=", "queue", ",", "no_ack", "=", "no_...
Declare a consumer.
[ "Declare", "a", "consumer", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/librabbitmq.py#L167-L173
ask/carrot
carrot/backends/librabbitmq.py
Backend.consume
def consume(self, limit=None): """Returns an iterator that waits for one message at a time.""" for total_message_count in count(): if limit and total_message_count >= limit: raise StopIteration if not self.channel.is_open: raise StopIteration ...
python
def consume(self, limit=None): """Returns an iterator that waits for one message at a time.""" for total_message_count in count(): if limit and total_message_count >= limit: raise StopIteration if not self.channel.is_open: raise StopIteration ...
[ "def", "consume", "(", "self", ",", "limit", "=", "None", ")", ":", "for", "total_message_count", "in", "count", "(", ")", ":", "if", "limit", "and", "total_message_count", ">=", "limit", ":", "raise", "StopIteration", "if", "not", "self", ".", "channel", ...
Returns an iterator that waits for one message at a time.
[ "Returns", "an", "iterator", "that", "waits", "for", "one", "message", "at", "a", "time", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/librabbitmq.py#L175-L185
ask/carrot
carrot/backends/librabbitmq.py
Backend.cancel
def cancel(self, consumer_tag): """Cancel a channel by consumer tag.""" if not self.channel.conn: return self.channel.basic_cancel(consumer_tag)
python
def cancel(self, consumer_tag): """Cancel a channel by consumer tag.""" if not self.channel.conn: return self.channel.basic_cancel(consumer_tag)
[ "def", "cancel", "(", "self", ",", "consumer_tag", ")", ":", "if", "not", "self", ".", "channel", ".", "conn", ":", "return", "self", ".", "channel", ".", "basic_cancel", "(", "consumer_tag", ")" ]
Cancel a channel by consumer tag.
[ "Cancel", "a", "channel", "by", "consumer", "tag", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/librabbitmq.py#L187-L191
ask/carrot
carrot/backends/librabbitmq.py
Backend.prepare_message
def prepare_message(self, message_data, delivery_mode, priority=None, content_type=None, content_encoding=None): """Encapsulate data into a AMQP message.""" return amqp.Message(message_data, properties={ "delivery_mode": delivery_mode, "priority": priority...
python
def prepare_message(self, message_data, delivery_mode, priority=None, content_type=None, content_encoding=None): """Encapsulate data into a AMQP message.""" return amqp.Message(message_data, properties={ "delivery_mode": delivery_mode, "priority": priority...
[ "def", "prepare_message", "(", "self", ",", "message_data", ",", "delivery_mode", ",", "priority", "=", "None", ",", "content_type", "=", "None", ",", "content_encoding", "=", "None", ")", ":", "return", "amqp", ".", "Message", "(", "message_data", ",", "pro...
Encapsulate data into a AMQP message.
[ "Encapsulate", "data", "into", "a", "AMQP", "message", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/librabbitmq.py#L211-L218
ask/carrot
carrot/serialization.py
raw_encode
def raw_encode(data): """Special case serializer.""" content_type = 'application/data' payload = data if isinstance(payload, unicode): content_encoding = 'utf-8' payload = payload.encode(content_encoding) else: content_encoding = 'binary' return content_type, content_enco...
python
def raw_encode(data): """Special case serializer.""" content_type = 'application/data' payload = data if isinstance(payload, unicode): content_encoding = 'utf-8' payload = payload.encode(content_encoding) else: content_encoding = 'binary' return content_type, content_enco...
[ "def", "raw_encode", "(", "data", ")", ":", "content_type", "=", "'application/data'", "payload", "=", "data", "if", "isinstance", "(", "payload", ",", "unicode", ")", ":", "content_encoding", "=", "'utf-8'", "payload", "=", "payload", ".", "encode", "(", "c...
Special case serializer.
[ "Special", "case", "serializer", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L202-L211
ask/carrot
carrot/serialization.py
register_json
def register_json(): """Register a encoder/decoder for JSON serialization.""" from anyjson import serialize as json_serialize from anyjson import deserialize as json_deserialize registry.register('json', json_serialize, json_deserialize, content_type='application/json', ...
python
def register_json(): """Register a encoder/decoder for JSON serialization.""" from anyjson import serialize as json_serialize from anyjson import deserialize as json_deserialize registry.register('json', json_serialize, json_deserialize, content_type='application/json', ...
[ "def", "register_json", "(", ")", ":", "from", "anyjson", "import", "serialize", "as", "json_serialize", "from", "anyjson", "import", "deserialize", "as", "json_deserialize", "registry", ".", "register", "(", "'json'", ",", "json_serialize", ",", "json_deserialize",...
Register a encoder/decoder for JSON serialization.
[ "Register", "a", "encoder", "/", "decoder", "for", "JSON", "serialization", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L214-L221
ask/carrot
carrot/serialization.py
register_yaml
def register_yaml(): """Register a encoder/decoder for YAML serialization. It is slower than JSON, but allows for more data types to be serialized. Useful if you need to send data such as dates""" try: import yaml registry.register('yaml', yaml.safe_dump, yaml.safe_load, ...
python
def register_yaml(): """Register a encoder/decoder for YAML serialization. It is slower than JSON, but allows for more data types to be serialized. Useful if you need to send data such as dates""" try: import yaml registry.register('yaml', yaml.safe_dump, yaml.safe_load, ...
[ "def", "register_yaml", "(", ")", ":", "try", ":", "import", "yaml", "registry", ".", "register", "(", "'yaml'", ",", "yaml", ".", "safe_dump", ",", "yaml", ".", "safe_load", ",", "content_type", "=", "'application/x-yaml'", ",", "content_encoding", "=", "'u...
Register a encoder/decoder for YAML serialization. It is slower than JSON, but allows for more data types to be serialized. Useful if you need to send data such as dates
[ "Register", "a", "encoder", "/", "decoder", "for", "YAML", "serialization", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L224-L241
ask/carrot
carrot/serialization.py
register_pickle
def register_pickle(): """The fastest serialization method, but restricts you to python clients.""" import cPickle registry.register('pickle', cPickle.dumps, cPickle.loads, content_type='application/x-python-serialize', content_encoding='binary')
python
def register_pickle(): """The fastest serialization method, but restricts you to python clients.""" import cPickle registry.register('pickle', cPickle.dumps, cPickle.loads, content_type='application/x-python-serialize', content_encoding='binary')
[ "def", "register_pickle", "(", ")", ":", "import", "cPickle", "registry", ".", "register", "(", "'pickle'", ",", "cPickle", ".", "dumps", ",", "cPickle", ".", "loads", ",", "content_type", "=", "'application/x-python-serialize'", ",", "content_encoding", "=", "'...
The fastest serialization method, but restricts you to python clients.
[ "The", "fastest", "serialization", "method", "but", "restricts", "you", "to", "python", "clients", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L244-L250
ask/carrot
carrot/serialization.py
register_msgpack
def register_msgpack(): """See http://msgpack.sourceforge.net/""" try: import msgpack registry.register('msgpack', msgpack.packs, msgpack.unpacks, content_type='application/x-msgpack', content_encoding='binary') except ImportError: def not_available(*...
python
def register_msgpack(): """See http://msgpack.sourceforge.net/""" try: import msgpack registry.register('msgpack', msgpack.packs, msgpack.unpacks, content_type='application/x-msgpack', content_encoding='binary') except ImportError: def not_available(*...
[ "def", "register_msgpack", "(", ")", ":", "try", ":", "import", "msgpack", "registry", ".", "register", "(", "'msgpack'", ",", "msgpack", ".", "packs", ",", "msgpack", ".", "unpacks", ",", "content_type", "=", "'application/x-msgpack'", ",", "content_encoding", ...
See http://msgpack.sourceforge.net/
[ "See", "http", ":", "//", "msgpack", ".", "sourceforge", ".", "net", "/" ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L253-L269
ask/carrot
carrot/serialization.py
SerializerRegistry.register
def register(self, name, encoder, decoder, content_type, content_encoding='utf-8'): """Register a new encoder/decoder. :param name: A convenience name for the serialization method. :param encoder: A method that will be passed a python data structure and should retu...
python
def register(self, name, encoder, decoder, content_type, content_encoding='utf-8'): """Register a new encoder/decoder. :param name: A convenience name for the serialization method. :param encoder: A method that will be passed a python data structure and should retu...
[ "def", "register", "(", "self", ",", "name", ",", "encoder", ",", "decoder", ",", "content_type", ",", "content_encoding", "=", "'utf-8'", ")", ":", "if", "encoder", ":", "self", ".", "_encoders", "[", "name", "]", "=", "(", "content_type", ",", "content...
Register a new encoder/decoder. :param name: A convenience name for the serialization method. :param encoder: A method that will be passed a python data structure and should return a string representing the serialized data. If ``None``, then only a decoder will be registered. E...
[ "Register", "a", "new", "encoder", "/", "decoder", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L41-L68
ask/carrot
carrot/serialization.py
SerializerRegistry._set_default_serializer
def _set_default_serializer(self, name): """ Set the default serialization method used by this library. :param name: The name of the registered serialization method. For example, ``json`` (default), ``pickle``, ``yaml``, or any custom methods registered using :meth:`regi...
python
def _set_default_serializer(self, name): """ Set the default serialization method used by this library. :param name: The name of the registered serialization method. For example, ``json`` (default), ``pickle``, ``yaml``, or any custom methods registered using :meth:`regi...
[ "def", "_set_default_serializer", "(", "self", ",", "name", ")", ":", "try", ":", "(", "self", ".", "_default_content_type", ",", "self", ".", "_default_content_encoding", ",", "self", ".", "_default_encode", ")", "=", "self", ".", "_encoders", "[", "name", ...
Set the default serialization method used by this library. :param name: The name of the registered serialization method. For example, ``json`` (default), ``pickle``, ``yaml``, or any custom methods registered using :meth:`register`. :raises SerializerNotInstalled: If the serial...
[ "Set", "the", "default", "serialization", "method", "used", "by", "this", "library", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L70-L86
ask/carrot
carrot/serialization.py
SerializerRegistry.encode
def encode(self, data, serializer=None): """ Serialize a data structure into a string suitable for sending as an AMQP message body. :param data: The message data to send. Can be a list, dictionary or a string. :keyword serializer: An optional string representing ...
python
def encode(self, data, serializer=None): """ Serialize a data structure into a string suitable for sending as an AMQP message body. :param data: The message data to send. Can be a list, dictionary or a string. :keyword serializer: An optional string representing ...
[ "def", "encode", "(", "self", ",", "data", ",", "serializer", "=", "None", ")", ":", "if", "serializer", "==", "\"raw\"", ":", "return", "raw_encode", "(", "data", ")", "if", "serializer", "and", "not", "self", ".", "_encoders", ".", "get", "(", "seria...
Serialize a data structure into a string suitable for sending as an AMQP message body. :param data: The message data to send. Can be a list, dictionary or a string. :keyword serializer: An optional string representing the serialization method you want the data marshalle...
[ "Serialize", "a", "data", "structure", "into", "a", "string", "suitable", "for", "sending", "as", "an", "AMQP", "message", "body", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L88-L145
ask/carrot
carrot/serialization.py
SerializerRegistry.decode
def decode(self, data, content_type, content_encoding): """Deserialize a data stream as serialized using ``encode`` based on :param:`content_type`. :param data: The message data to deserialize. :param content_type: The content-type of the data. (e.g., ``application/json``)....
python
def decode(self, data, content_type, content_encoding): """Deserialize a data stream as serialized using ``encode`` based on :param:`content_type`. :param data: The message data to deserialize. :param content_type: The content-type of the data. (e.g., ``application/json``)....
[ "def", "decode", "(", "self", ",", "data", ",", "content_type", ",", "content_encoding", ")", ":", "content_type", "=", "content_type", "or", "'application/data'", "content_encoding", "=", "(", "content_encoding", "or", "'utf-8'", ")", ".", "lower", "(", ")", ...
Deserialize a data stream as serialized using ``encode`` based on :param:`content_type`. :param data: The message data to deserialize. :param content_type: The content-type of the data. (e.g., ``application/json``). :param content_encoding: The content-encoding of the data...
[ "Deserialize", "a", "data", "stream", "as", "serialized", "using", "encode", "based", "on", ":", "param", ":", "content_type", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/serialization.py#L147-L174
ask/carrot
carrot/backends/pystomp.py
Message.ack
def ack(self): """Acknowledge this message as being processed., This will remove the message from the queue. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowledged: raise self.MessageStateError...
python
def ack(self): """Acknowledge this message as being processed., This will remove the message from the queue. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowledged: raise self.MessageStateError...
[ "def", "ack", "(", "self", ")", ":", "if", "self", ".", "acknowledged", ":", "raise", "self", ".", "MessageStateError", "(", "\"Message already acknowledged with state: %s\"", "%", "self", ".", "_state", ")", "self", ".", "backend", ".", "ack", "(", "self", ...
Acknowledge this message as being processed., This will remove the message from the queue. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected.
[ "Acknowledge", "this", "message", "as", "being", "processed", ".", "This", "will", "remove", "the", "message", "from", "the", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pystomp.py#L54-L66
ask/carrot
carrot/backends/pystomp.py
Backend.consume
def consume(self, limit=None): """Returns an iterator that waits for one message at a time.""" for total_message_count in count(): if limit and total_message_count >= limit: raise StopIteration self.drain_events() yield True
python
def consume(self, limit=None): """Returns an iterator that waits for one message at a time.""" for total_message_count in count(): if limit and total_message_count >= limit: raise StopIteration self.drain_events() yield True
[ "def", "consume", "(", "self", ",", "limit", "=", "None", ")", ":", "for", "total_message_count", "in", "count", "(", ")", ":", "if", "limit", "and", "total_message_count", ">=", "limit", ":", "raise", "StopIteration", "self", ".", "drain_events", "(", ")"...
Returns an iterator that waits for one message at a time.
[ "Returns", "an", "iterator", "that", "waits", "for", "one", "message", "at", "a", "time", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pystomp.py#L136-L142
hosford42/xcs
xcs/_numpy_bitstrings.py
BitString.random
def random(cls, length, bit_prob=.5): """Create a bit string of the given length, with the probability of each bit being set equal to bit_prob, which defaults to .5. Usage: # Create a random BitString of length 10 with mostly zeros. bits = BitString.random(10, bit_prob=....
python
def random(cls, length, bit_prob=.5): """Create a bit string of the given length, with the probability of each bit being set equal to bit_prob, which defaults to .5. Usage: # Create a random BitString of length 10 with mostly zeros. bits = BitString.random(10, bit_prob=....
[ "def", "random", "(", "cls", ",", "length", ",", "bit_prob", "=", ".5", ")", ":", "assert", "isinstance", "(", "length", ",", "int", ")", "and", "length", ">=", "0", "assert", "isinstance", "(", "bit_prob", ",", "(", "int", ",", "float", ")", ")", ...
Create a bit string of the given length, with the probability of each bit being set equal to bit_prob, which defaults to .5. Usage: # Create a random BitString of length 10 with mostly zeros. bits = BitString.random(10, bit_prob=.1) Arguments: length: An int...
[ "Create", "a", "bit", "string", "of", "the", "given", "length", "with", "the", "probability", "of", "each", "bit", "being", "set", "equal", "to", "bit_prob", "which", "defaults", "to", ".", "5", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/_numpy_bitstrings.py#L162-L191
hosford42/xcs
xcs/_numpy_bitstrings.py
BitString.crossover_template
def crossover_template(cls, length, points=2): """Create a crossover template with the given number of points. The crossover template can be used as a mask to crossover two bitstrings of the same length. Usage: assert len(parent1) == len(parent2) template = BitSt...
python
def crossover_template(cls, length, points=2): """Create a crossover template with the given number of points. The crossover template can be used as a mask to crossover two bitstrings of the same length. Usage: assert len(parent1) == len(parent2) template = BitSt...
[ "def", "crossover_template", "(", "cls", ",", "length", ",", "points", "=", "2", ")", ":", "assert", "isinstance", "(", "length", ",", "int", ")", "and", "length", ">=", "0", "assert", "isinstance", "(", "points", ",", "int", ")", "and", "points", ">="...
Create a crossover template with the given number of points. The crossover template can be used as a mask to crossover two bitstrings of the same length. Usage: assert len(parent1) == len(parent2) template = BitString.crossover_template(len(parent1)) inv_temp...
[ "Create", "a", "crossover", "template", "with", "the", "given", "number", "of", "points", ".", "The", "crossover", "template", "can", "be", "used", "as", "a", "mask", "to", "crossover", "two", "bitstrings", "of", "the", "same", "length", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/_numpy_bitstrings.py#L194-L238
hosford42/xcs
xcs/bitstrings.py
BitCondition.cover
def cover(cls, bits, wildcard_probability): """Create a new bit condition that matches the provided bit string, with the indicated per-index wildcard probability. Usage: condition = BitCondition.cover(bitstring, .33) assert condition(bitstring) Arguments: ...
python
def cover(cls, bits, wildcard_probability): """Create a new bit condition that matches the provided bit string, with the indicated per-index wildcard probability. Usage: condition = BitCondition.cover(bitstring, .33) assert condition(bitstring) Arguments: ...
[ "def", "cover", "(", "cls", ",", "bits", ",", "wildcard_probability", ")", ":", "if", "not", "isinstance", "(", "bits", ",", "BitString", ")", ":", "bits", "=", "BitString", "(", "bits", ")", "mask", "=", "BitString", "(", "[", "random", ".", "random",...
Create a new bit condition that matches the provided bit string, with the indicated per-index wildcard probability. Usage: condition = BitCondition.cover(bitstring, .33) assert condition(bitstring) Arguments: bits: A BitString which the resulting condition m...
[ "Create", "a", "new", "bit", "condition", "that", "matches", "the", "provided", "bit", "string", "with", "the", "indicated", "per", "-", "index", "wildcard", "probability", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/bitstrings.py#L455-L480
hosford42/xcs
xcs/bitstrings.py
BitCondition.crossover_with
def crossover_with(self, other, points=2): """Perform 2-point crossover on this bit condition and another of the same length, returning the two resulting children. Usage: offspring1, offspring2 = condition1.crossover_with(condition2) Arguments: other: A second B...
python
def crossover_with(self, other, points=2): """Perform 2-point crossover on this bit condition and another of the same length, returning the two resulting children. Usage: offspring1, offspring2 = condition1.crossover_with(condition2) Arguments: other: A second B...
[ "def", "crossover_with", "(", "self", ",", "other", ",", "points", "=", "2", ")", ":", "assert", "isinstance", "(", "other", ",", "BitCondition", ")", "assert", "len", "(", "self", ")", "==", "len", "(", "other", ")", "template", "=", "BitString", ".",...
Perform 2-point crossover on this bit condition and another of the same length, returning the two resulting children. Usage: offspring1, offspring2 = condition1.crossover_with(condition2) Arguments: other: A second BitCondition of the same length as this one. ...
[ "Perform", "2", "-", "point", "crossover", "on", "this", "bit", "condition", "and", "another", "of", "the", "same", "length", "returning", "the", "two", "resulting", "children", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/bitstrings.py#L652-L682
ask/carrot
carrot/connection.py
BrokerConnection.get_backend_cls
def get_backend_cls(self): """Get the currently used backend class.""" backend_cls = self.backend_cls if not backend_cls or isinstance(backend_cls, basestring): backend_cls = get_backend_cls(backend_cls) return backend_cls
python
def get_backend_cls(self): """Get the currently used backend class.""" backend_cls = self.backend_cls if not backend_cls or isinstance(backend_cls, basestring): backend_cls = get_backend_cls(backend_cls) return backend_cls
[ "def", "get_backend_cls", "(", "self", ")", ":", "backend_cls", "=", "self", ".", "backend_cls", "if", "not", "backend_cls", "or", "isinstance", "(", "backend_cls", ",", "basestring", ")", ":", "backend_cls", "=", "get_backend_cls", "(", "backend_cls", ")", "r...
Get the currently used backend class.
[ "Get", "the", "currently", "used", "backend", "class", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/connection.py#L152-L157
ask/carrot
carrot/connection.py
BrokerConnection.ensure_connection
def ensure_connection(self, errback=None, max_retries=None, interval_start=2, interval_step=2, interval_max=30): """Ensure we have a connection to the server. If not retry establishing the connection with the settings specified. :keyword errback: Optional callback called ea...
python
def ensure_connection(self, errback=None, max_retries=None, interval_start=2, interval_step=2, interval_max=30): """Ensure we have a connection to the server. If not retry establishing the connection with the settings specified. :keyword errback: Optional callback called ea...
[ "def", "ensure_connection", "(", "self", ",", "errback", "=", "None", ",", "max_retries", "=", "None", ",", "interval_start", "=", "2", ",", "interval_step", "=", "2", ",", "interval_max", "=", "30", ")", ":", "retry_over_time", "(", "self", ".", "connect"...
Ensure we have a connection to the server. If not retry establishing the connection with the settings specified. :keyword errback: Optional callback called each time the connection can't be established. Arguments provided are the exception raised and the interval that will ...
[ "Ensure", "we", "have", "a", "connection", "to", "the", "server", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/connection.py#L181-L205
ask/carrot
carrot/connection.py
BrokerConnection.close
def close(self): """Close the currently open connection.""" try: if self._connection: backend = self.create_backend() backend.close_connection(self._connection) except socket.error: pass self._closed = True
python
def close(self): """Close the currently open connection.""" try: if self._connection: backend = self.create_backend() backend.close_connection(self._connection) except socket.error: pass self._closed = True
[ "def", "close", "(", "self", ")", ":", "try", ":", "if", "self", ".", "_connection", ":", "backend", "=", "self", ".", "create_backend", "(", ")", "backend", ".", "close_connection", "(", "self", ".", "_connection", ")", "except", "socket", ".", "error",...
Close the currently open connection.
[ "Close", "the", "currently", "open", "connection", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/connection.py#L207-L215
ask/carrot
carrot/connection.py
BrokerConnection.info
def info(self): """Get connection info.""" backend_cls = self.backend_cls or "amqplib" port = self.port or self.create_backend().default_port return {"hostname": self.hostname, "userid": self.userid, "password": self.password, "virtual_host...
python
def info(self): """Get connection info.""" backend_cls = self.backend_cls or "amqplib" port = self.port or self.create_backend().default_port return {"hostname": self.hostname, "userid": self.userid, "password": self.password, "virtual_host...
[ "def", "info", "(", "self", ")", ":", "backend_cls", "=", "self", ".", "backend_cls", "or", "\"amqplib\"", "port", "=", "self", ".", "port", "or", "self", ".", "create_backend", "(", ")", ".", "default_port", "return", "{", "\"hostname\"", ":", "self", "...
Get connection info.
[ "Get", "connection", "info", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/connection.py#L223-L236
ask/carrot
carrot/backends/base.py
BaseMessage.decode
def decode(self): """Deserialize the message body, returning the original python structure sent by the publisher.""" return serialization.decode(self.body, self.content_type, self.content_encoding)
python
def decode(self): """Deserialize the message body, returning the original python structure sent by the publisher.""" return serialization.decode(self.body, self.content_type, self.content_encoding)
[ "def", "decode", "(", "self", ")", ":", "return", "serialization", ".", "decode", "(", "self", ".", "body", ",", "self", ".", "content_type", ",", "self", ".", "content_encoding", ")" ]
Deserialize the message body, returning the original python structure sent by the publisher.
[ "Deserialize", "the", "message", "body", "returning", "the", "original", "python", "structure", "sent", "by", "the", "publisher", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/base.py#L31-L35
ask/carrot
carrot/backends/base.py
BaseMessage.payload
def payload(self): """The decoded message.""" if not self._decoded_cache: self._decoded_cache = self.decode() return self._decoded_cache
python
def payload(self): """The decoded message.""" if not self._decoded_cache: self._decoded_cache = self.decode() return self._decoded_cache
[ "def", "payload", "(", "self", ")", ":", "if", "not", "self", ".", "_decoded_cache", ":", "self", ".", "_decoded_cache", "=", "self", ".", "decode", "(", ")", "return", "self", ".", "_decoded_cache" ]
The decoded message.
[ "The", "decoded", "message", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/base.py#L38-L42
ask/carrot
carrot/backends/base.py
BaseMessage.ack
def ack(self): """Acknowledge this message as being processed., This will remove the message from the queue. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowledged: raise self.MessageStateError...
python
def ack(self): """Acknowledge this message as being processed., This will remove the message from the queue. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowledged: raise self.MessageStateError...
[ "def", "ack", "(", "self", ")", ":", "if", "self", ".", "acknowledged", ":", "raise", "self", ".", "MessageStateError", "(", "\"Message already acknowledged with state: %s\"", "%", "self", ".", "_state", ")", "self", ".", "backend", ".", "ack", "(", "self", ...
Acknowledge this message as being processed., This will remove the message from the queue. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected.
[ "Acknowledge", "this", "message", "as", "being", "processed", ".", "This", "will", "remove", "the", "message", "from", "the", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/base.py#L44-L56
ask/carrot
carrot/backends/base.py
BaseMessage.reject
def reject(self): """Reject this message. The message will be discarded by the server. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowledged: raise self.MessageStateError( "Me...
python
def reject(self): """Reject this message. The message will be discarded by the server. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowledged: raise self.MessageStateError( "Me...
[ "def", "reject", "(", "self", ")", ":", "if", "self", ".", "acknowledged", ":", "raise", "self", ".", "MessageStateError", "(", "\"Message already acknowledged with state: %s\"", "%", "self", ".", "_state", ")", "self", ".", "backend", ".", "reject", "(", "sel...
Reject this message. The message will be discarded by the server. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected.
[ "Reject", "this", "message", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/base.py#L58-L71
ask/carrot
carrot/backends/base.py
BaseMessage.requeue
def requeue(self): """Reject this message and put it back on the queue. You must not use this method as a means of selecting messages to process. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowle...
python
def requeue(self): """Reject this message and put it back on the queue. You must not use this method as a means of selecting messages to process. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected. """ if self.acknowle...
[ "def", "requeue", "(", "self", ")", ":", "if", "self", ".", "acknowledged", ":", "raise", "self", ".", "MessageStateError", "(", "\"Message already acknowledged with state: %s\"", "%", "self", ".", "_state", ")", "self", ".", "backend", ".", "requeue", "(", "s...
Reject this message and put it back on the queue. You must not use this method as a means of selecting messages to process. :raises MessageStateError: If the message has already been acknowledged/requeued/rejected.
[ "Reject", "this", "message", "and", "put", "it", "back", "on", "the", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/base.py#L73-L87
ask/carrot
carrot/utils.py
gen_unique_id
def gen_unique_id(): """Generate a unique id, having - hopefully - a very small chance of collission. For now this is provided by :func:`uuid.uuid4`. """ # Workaround for http://bugs.python.org/issue4607 if ctypes and _uuid_generate_random: buffer = ctypes.create_string_buffer(16) ...
python
def gen_unique_id(): """Generate a unique id, having - hopefully - a very small chance of collission. For now this is provided by :func:`uuid.uuid4`. """ # Workaround for http://bugs.python.org/issue4607 if ctypes and _uuid_generate_random: buffer = ctypes.create_string_buffer(16) ...
[ "def", "gen_unique_id", "(", ")", ":", "# Workaround for http://bugs.python.org/issue4607", "if", "ctypes", "and", "_uuid_generate_random", ":", "buffer", "=", "ctypes", ".", "create_string_buffer", "(", "16", ")", "_uuid_generate_random", "(", "buffer", ")", "return", ...
Generate a unique id, having - hopefully - a very small chance of collission. For now this is provided by :func:`uuid.uuid4`.
[ "Generate", "a", "unique", "id", "having", "-", "hopefully", "-", "a", "very", "small", "chance", "of", "collission", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/utils.py#L8-L19
ask/carrot
carrot/utils.py
retry_over_time
def retry_over_time(fun, catch, args=[], kwargs={}, errback=None, max_retries=None, interval_start=2, interval_step=2, interval_max=30): """Retry the function over and over until max retries is exceeded. For each retry we sleep a for a while before we try again, this interval is increased for every...
python
def retry_over_time(fun, catch, args=[], kwargs={}, errback=None, max_retries=None, interval_start=2, interval_step=2, interval_max=30): """Retry the function over and over until max retries is exceeded. For each retry we sleep a for a while before we try again, this interval is increased for every...
[ "def", "retry_over_time", "(", "fun", ",", "catch", ",", "args", "=", "[", "]", ",", "kwargs", "=", "{", "}", ",", "errback", "=", "None", ",", "max_retries", "=", "None", ",", "interval_start", "=", "2", ",", "interval_step", "=", "2", ",", "interva...
Retry the function over and over until max retries is exceeded. For each retry we sleep a for a while before we try again, this interval is increased for every retry until the max seconds is reached. :param fun: The function to try :param catch: Exceptions to catch, can be either tuple or a single ...
[ "Retry", "the", "function", "over", "and", "over", "until", "max", "retries", "is", "exceeded", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/utils.py#L78-L118
ask/carrot
carrot/backends/queue.py
Backend.get
def get(self, *args, **kwargs): """Get the next waiting message from the queue. :returns: A :class:`Message` instance, or ``None`` if there is no messages waiting. """ if not mqueue.qsize(): return None message_data, content_type, content_encoding = mque...
python
def get(self, *args, **kwargs): """Get the next waiting message from the queue. :returns: A :class:`Message` instance, or ``None`` if there is no messages waiting. """ if not mqueue.qsize(): return None message_data, content_type, content_encoding = mque...
[ "def", "get", "(", "self", ",", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "not", "mqueue", ".", "qsize", "(", ")", ":", "return", "None", "message_data", ",", "content_type", ",", "content_encoding", "=", "mqueue", ".", "get", "(", ")", ...
Get the next waiting message from the queue. :returns: A :class:`Message` instance, or ``None`` if there is no messages waiting.
[ "Get", "the", "next", "waiting", "message", "from", "the", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/queue.py#L33-L45
ask/carrot
carrot/backends/queue.py
Backend.queue_purge
def queue_purge(self, queue, **kwargs): """Discard all messages in the queue.""" qsize = mqueue.qsize() mqueue.queue.clear() return qsize
python
def queue_purge(self, queue, **kwargs): """Discard all messages in the queue.""" qsize = mqueue.qsize() mqueue.queue.clear() return qsize
[ "def", "queue_purge", "(", "self", ",", "queue", ",", "*", "*", "kwargs", ")", ":", "qsize", "=", "mqueue", ".", "qsize", "(", ")", "mqueue", ".", "queue", ".", "clear", "(", ")", "return", "qsize" ]
Discard all messages in the queue.
[ "Discard", "all", "messages", "in", "the", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/queue.py#L74-L78
ask/carrot
carrot/backends/queue.py
Backend.prepare_message
def prepare_message(self, message_data, delivery_mode, content_type, content_encoding, **kwargs): """Prepare message for sending.""" return (message_data, content_type, content_encoding)
python
def prepare_message(self, message_data, delivery_mode, content_type, content_encoding, **kwargs): """Prepare message for sending.""" return (message_data, content_type, content_encoding)
[ "def", "prepare_message", "(", "self", ",", "message_data", ",", "delivery_mode", ",", "content_type", ",", "content_encoding", ",", "*", "*", "kwargs", ")", ":", "return", "(", "message_data", ",", "content_type", ",", "content_encoding", ")" ]
Prepare message for sending.
[ "Prepare", "message", "for", "sending", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/queue.py#L80-L83
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm.get_future_expectation
def get_future_expectation(self, match_set): """Return a numerical value representing the expected future payoff of the previously selected action, given only the current match set. The match_set argument is a MatchSet instance representing the current match set. Usage: ...
python
def get_future_expectation(self, match_set): """Return a numerical value representing the expected future payoff of the previously selected action, given only the current match set. The match_set argument is a MatchSet instance representing the current match set. Usage: ...
[ "def", "get_future_expectation", "(", "self", ",", "match_set", ")", ":", "assert", "isinstance", "(", "match_set", ",", "MatchSet", ")", "assert", "match_set", ".", "algorithm", "is", "self", "return", "self", ".", "discount_factor", "*", "(", "self", ".", ...
Return a numerical value representing the expected future payoff of the previously selected action, given only the current match set. The match_set argument is a MatchSet instance representing the current match set. Usage: match_set = model.match(situation) expec...
[ "Return", "a", "numerical", "value", "representing", "the", "expected", "future", "payoff", "of", "the", "previously", "selected", "action", "given", "only", "the", "current", "match", "set", ".", "The", "match_set", "argument", "is", "a", "MatchSet", "instance"...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L383-L408
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm.covering_is_required
def covering_is_required(self, match_set): """Return a Boolean indicating whether covering is required for the current match set. The match_set argument is a MatchSet instance representing the current match set before covering is applied. Usage: match_set = model.match(situa...
python
def covering_is_required(self, match_set): """Return a Boolean indicating whether covering is required for the current match set. The match_set argument is a MatchSet instance representing the current match set before covering is applied. Usage: match_set = model.match(situa...
[ "def", "covering_is_required", "(", "self", ",", "match_set", ")", ":", "assert", "isinstance", "(", "match_set", ",", "MatchSet", ")", "assert", "match_set", ".", "algorithm", "is", "self", "if", "self", ".", "minimum_actions", "is", "None", ":", "return", ...
Return a Boolean indicating whether covering is required for the current match set. The match_set argument is a MatchSet instance representing the current match set before covering is applied. Usage: match_set = model.match(situation) if model.algorithm.covering_is_requi...
[ "Return", "a", "Boolean", "indicating", "whether", "covering", "is", "required", "for", "the", "current", "match", "set", ".", "The", "match_set", "argument", "is", "a", "MatchSet", "instance", "representing", "the", "current", "match", "set", "before", "coverin...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L410-L436
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm.cover
def cover(self, match_set): """Return a new classifier rule that can be added to the match set, with a condition that matches the situation of the match set and an action selected to avoid duplication of the actions already contained therein. The match_set argument is a MatchSet instance...
python
def cover(self, match_set): """Return a new classifier rule that can be added to the match set, with a condition that matches the situation of the match set and an action selected to avoid duplication of the actions already contained therein. The match_set argument is a MatchSet instance...
[ "def", "cover", "(", "self", ",", "match_set", ")", ":", "assert", "isinstance", "(", "match_set", ",", "MatchSet", ")", "assert", "match_set", ".", "model", ".", "algorithm", "is", "self", "# Create a new condition that matches the situation.", "condition", "=", ...
Return a new classifier rule that can be added to the match set, with a condition that matches the situation of the match set and an action selected to avoid duplication of the actions already contained therein. The match_set argument is a MatchSet instance representing the match set to ...
[ "Return", "a", "new", "classifier", "rule", "that", "can", "be", "added", "to", "the", "match", "set", "with", "a", "condition", "that", "matches", "the", "situation", "of", "the", "match", "set", "and", "an", "action", "selected", "to", "avoid", "duplicat...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L438-L486
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm.distribute_payoff
def distribute_payoff(self, match_set): """Distribute the payoff received in response to the selected action of the given match set among the rules in the action set which deserve credit for recommending the action. The match_set argument is the MatchSet instance which suggested the sele...
python
def distribute_payoff(self, match_set): """Distribute the payoff received in response to the selected action of the given match set among the rules in the action set which deserve credit for recommending the action. The match_set argument is the MatchSet instance which suggested the sele...
[ "def", "distribute_payoff", "(", "self", ",", "match_set", ")", ":", "assert", "isinstance", "(", "match_set", ",", "MatchSet", ")", "assert", "match_set", ".", "algorithm", "is", "self", "assert", "match_set", ".", "selected_action", "is", "not", "None", "pay...
Distribute the payoff received in response to the selected action of the given match set among the rules in the action set which deserve credit for recommending the action. The match_set argument is the MatchSet instance which suggested the selected action and earned the payoff. ...
[ "Distribute", "the", "payoff", "received", "in", "response", "to", "the", "selected", "action", "of", "the", "given", "match", "set", "among", "the", "rules", "in", "the", "action", "set", "which", "deserve", "credit", "for", "recommending", "the", "action", ...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L488-L544
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm.update
def update(self, match_set): """Update the classifier set from which the match set was drawn, e.g. by applying a genetic algorithm. The match_set argument is the MatchSet instance whose classifier set should be updated. Usage: match_set = model.match(situation) m...
python
def update(self, match_set): """Update the classifier set from which the match set was drawn, e.g. by applying a genetic algorithm. The match_set argument is the MatchSet instance whose classifier set should be updated. Usage: match_set = model.match(situation) m...
[ "def", "update", "(", "self", ",", "match_set", ")", ":", "assert", "isinstance", "(", "match_set", ",", "MatchSet", ")", "assert", "match_set", ".", "model", ".", "algorithm", "is", "self", "assert", "match_set", ".", "selected_action", "is", "not", "None",...
Update the classifier set from which the match set was drawn, e.g. by applying a genetic algorithm. The match_set argument is the MatchSet instance whose classifier set should be updated. Usage: match_set = model.match(situation) match_set.select_action() mat...
[ "Update", "the", "classifier", "set", "from", "which", "the", "match", "set", "was", "drawn", "e", ".", "g", ".", "by", "applying", "a", "genetic", "algorithm", ".", "The", "match_set", "argument", "is", "the", "MatchSet", "instance", "whose", "classifier", ...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L546-L676
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm.prune
def prune(self, model): """Reduce the classifier set's population size, if necessary, by removing lower-quality *rules. Return a list containing any rules whose numerosities dropped to zero as a result of this call. (The list may be empty, if no rule's numerosity dropped to 0.) The ...
python
def prune(self, model): """Reduce the classifier set's population size, if necessary, by removing lower-quality *rules. Return a list containing any rules whose numerosities dropped to zero as a result of this call. (The list may be empty, if no rule's numerosity dropped to 0.) The ...
[ "def", "prune", "(", "self", ",", "model", ")", ":", "assert", "isinstance", "(", "model", ",", "ClassifierSet", ")", "assert", "model", ".", "algorithm", "is", "self", "# Determine the (virtual) population size.", "total_numerosity", "=", "sum", "(", "rule", "....
Reduce the classifier set's population size, if necessary, by removing lower-quality *rules. Return a list containing any rules whose numerosities dropped to zero as a result of this call. (The list may be empty, if no rule's numerosity dropped to 0.) The model argument is a ClassifierSe...
[ "Reduce", "the", "classifier", "set", "s", "population", "size", "if", "necessary", "by", "removing", "lower", "-", "quality", "*", "rules", ".", "Return", "a", "list", "containing", "any", "rules", "whose", "numerosities", "dropped", "to", "zero", "as", "a"...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L678-L744
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm._update_fitness
def _update_fitness(self, action_set): """Update the fitness values of the rules belonging to this action set.""" # Compute the accuracy of each rule. Accuracy is inversely # proportional to error. Below a certain error threshold, accuracy # becomes constant. Accuracy values rang...
python
def _update_fitness(self, action_set): """Update the fitness values of the rules belonging to this action set.""" # Compute the accuracy of each rule. Accuracy is inversely # proportional to error. Below a certain error threshold, accuracy # becomes constant. Accuracy values rang...
[ "def", "_update_fitness", "(", "self", ",", "action_set", ")", ":", "# Compute the accuracy of each rule. Accuracy is inversely", "# proportional to error. Below a certain error threshold, accuracy", "# becomes constant. Accuracy values range over (0, 1].", "total_accuracy", "=", "0", "a...
Update the fitness values of the rules belonging to this action set.
[ "Update", "the", "fitness", "values", "of", "the", "rules", "belonging", "to", "this", "action", "set", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L746-L777
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm._action_set_subsumption
def _action_set_subsumption(self, action_set): """Perform action set subsumption.""" # Select a condition with maximum bit count among those having # sufficient experience and sufficiently low error. selected_rule = None selected_bit_count = None for rule in action_set: ...
python
def _action_set_subsumption(self, action_set): """Perform action set subsumption.""" # Select a condition with maximum bit count among those having # sufficient experience and sufficiently low error. selected_rule = None selected_bit_count = None for rule in action_set: ...
[ "def", "_action_set_subsumption", "(", "self", ",", "action_set", ")", ":", "# Select a condition with maximum bit count among those having", "# sufficient experience and sufficiently low error.", "selected_rule", "=", "None", "selected_bit_count", "=", "None", "for", "rule", "in...
Perform action set subsumption.
[ "Perform", "action", "set", "subsumption", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L779-L813
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm._get_average_time_stamp
def _get_average_time_stamp(action_set): """Return the average time stamp for the rules in this action set.""" # This is the average value of the iteration counter upon the most # recent update of each rule in this action set. total_time_stamps = sum(rule.time_stamp * rule.numero...
python
def _get_average_time_stamp(action_set): """Return the average time stamp for the rules in this action set.""" # This is the average value of the iteration counter upon the most # recent update of each rule in this action set. total_time_stamps = sum(rule.time_stamp * rule.numero...
[ "def", "_get_average_time_stamp", "(", "action_set", ")", ":", "# This is the average value of the iteration counter upon the most", "# recent update of each rule in this action set.", "total_time_stamps", "=", "sum", "(", "rule", ".", "time_stamp", "*", "rule", ".", "numerosity"...
Return the average time stamp for the rules in this action set.
[ "Return", "the", "average", "time", "stamp", "for", "the", "rules", "in", "this", "action", "set", "." ]
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L816-L824
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm._select_parent
def _select_parent(action_set): """Select a rule from this action set, with probability proportionate to its fitness, to act as a parent for a new rule in the classifier set. Return the selected rule.""" total_fitness = sum(rule.fitness for rule in action_set) selector = random.u...
python
def _select_parent(action_set): """Select a rule from this action set, with probability proportionate to its fitness, to act as a parent for a new rule in the classifier set. Return the selected rule.""" total_fitness = sum(rule.fitness for rule in action_set) selector = random.u...
[ "def", "_select_parent", "(", "action_set", ")", ":", "total_fitness", "=", "sum", "(", "rule", ".", "fitness", "for", "rule", "in", "action_set", ")", "selector", "=", "random", ".", "uniform", "(", "0", ",", "total_fitness", ")", "for", "rule", "in", "...
Select a rule from this action set, with probability proportionate to its fitness, to act as a parent for a new rule in the classifier set. Return the selected rule.
[ "Select", "a", "rule", "from", "this", "action", "set", "with", "probability", "proportionate", "to", "its", "fitness", "to", "act", "as", "a", "parent", "for", "a", "new", "rule", "in", "the", "classifier", "set", ".", "Return", "the", "selected", "rule",...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L835-L847
hosford42/xcs
xcs/algorithms/xcs.py
XCSAlgorithm._mutate
def _mutate(self, condition, situation): """Create a new condition from the given one by probabilistically applying point-wise mutations. Bits that were originally wildcarded in the parent condition acquire their values from the provided situation, to ensure the child condition continues...
python
def _mutate(self, condition, situation): """Create a new condition from the given one by probabilistically applying point-wise mutations. Bits that were originally wildcarded in the parent condition acquire their values from the provided situation, to ensure the child condition continues...
[ "def", "_mutate", "(", "self", ",", "condition", ",", "situation", ")", ":", "# Go through each position in the condition, randomly flipping", "# whether the position is a value (0 or 1) or a wildcard (#). We do", "# this in a new list because the original condition's mask is", "# immutabl...
Create a new condition from the given one by probabilistically applying point-wise mutations. Bits that were originally wildcarded in the parent condition acquire their values from the provided situation, to ensure the child condition continues to match it.
[ "Create", "a", "new", "condition", "from", "the", "given", "one", "by", "probabilistically", "applying", "point", "-", "wise", "mutations", ".", "Bits", "that", "were", "originally", "wildcarded", "in", "the", "parent", "condition", "acquire", "their", "values",...
train
https://github.com/hosford42/xcs/blob/183bdd0dd339e19ded3be202f86e1b38bdb9f1e5/xcs/algorithms/xcs.py#L849-L871
ask/carrot
carrot/backends/pikachu.py
SyncBackend.establish_connection
def establish_connection(self): """Establish connection to the AMQP broker.""" conninfo = self.connection if not conninfo.port: conninfo.port = self.default_port credentials = pika.PlainCredentials(conninfo.userid, conninfo.password...
python
def establish_connection(self): """Establish connection to the AMQP broker.""" conninfo = self.connection if not conninfo.port: conninfo.port = self.default_port credentials = pika.PlainCredentials(conninfo.userid, conninfo.password...
[ "def", "establish_connection", "(", "self", ")", ":", "conninfo", "=", "self", ".", "connection", "if", "not", "conninfo", ".", "port", ":", "conninfo", ".", "port", "=", "self", ".", "default_port", "credentials", "=", "pika", ".", "PlainCredentials", "(", ...
Establish connection to the AMQP broker.
[ "Establish", "connection", "to", "the", "AMQP", "broker", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pikachu.py#L57-L68
ask/carrot
carrot/backends/pikachu.py
SyncBackend.queue_purge
def queue_purge(self, queue, **kwargs): """Discard all messages in the queue. This will delete the messages and results in an empty queue.""" return self.channel.queue_purge(queue=queue).message_count
python
def queue_purge(self, queue, **kwargs): """Discard all messages in the queue. This will delete the messages and results in an empty queue.""" return self.channel.queue_purge(queue=queue).message_count
[ "def", "queue_purge", "(", "self", ",", "queue", ",", "*", "*", "kwargs", ")", ":", "return", "self", ".", "channel", ".", "queue_purge", "(", "queue", "=", "queue", ")", ".", "message_count" ]
Discard all messages in the queue. This will delete the messages and results in an empty queue.
[ "Discard", "all", "messages", "in", "the", "queue", ".", "This", "will", "delete", "the", "messages", "and", "results", "in", "an", "empty", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pikachu.py#L82-L85
ask/carrot
carrot/backends/pikachu.py
SyncBackend.queue_declare
def queue_declare(self, queue, durable, exclusive, auto_delete, warn_if_exists=False, arguments=None): """Declare a named queue.""" return self.channel.queue_declare(queue=queue, durable=durable, exclusive=e...
python
def queue_declare(self, queue, durable, exclusive, auto_delete, warn_if_exists=False, arguments=None): """Declare a named queue.""" return self.channel.queue_declare(queue=queue, durable=durable, exclusive=e...
[ "def", "queue_declare", "(", "self", ",", "queue", ",", "durable", ",", "exclusive", ",", "auto_delete", ",", "warn_if_exists", "=", "False", ",", "arguments", "=", "None", ")", ":", "return", "self", ".", "channel", ".", "queue_declare", "(", "queue", "="...
Declare a named queue.
[ "Declare", "a", "named", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pikachu.py#L87-L95
ask/carrot
carrot/backends/pikachu.py
SyncBackend.declare_consumer
def declare_consumer(self, queue, no_ack, callback, consumer_tag, nowait=False): """Declare a consumer.""" @functools.wraps(callback) def _callback_decode(channel, method, header, body): return callback((channel, method, header, body)) return self.channel.basic_...
python
def declare_consumer(self, queue, no_ack, callback, consumer_tag, nowait=False): """Declare a consumer.""" @functools.wraps(callback) def _callback_decode(channel, method, header, body): return callback((channel, method, header, body)) return self.channel.basic_...
[ "def", "declare_consumer", "(", "self", ",", "queue", ",", "no_ack", ",", "callback", ",", "consumer_tag", ",", "nowait", "=", "False", ")", ":", "@", "functools", ".", "wraps", "(", "callback", ")", "def", "_callback_decode", "(", "channel", ",", "method"...
Declare a consumer.
[ "Declare", "a", "consumer", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pikachu.py#L130-L141
ask/carrot
carrot/backends/pikachu.py
SyncBackend.close
def close(self): """Close the channel if open.""" if self._channel and not self._channel.handler.channel_close: self._channel.close() self._channel_ref = None
python
def close(self): """Close the channel if open.""" if self._channel and not self._channel.handler.channel_close: self._channel.close() self._channel_ref = None
[ "def", "close", "(", "self", ")", ":", "if", "self", ".", "_channel", "and", "not", "self", ".", "_channel", ".", "handler", ".", "channel_close", ":", "self", ".", "_channel", ".", "close", "(", ")", "self", ".", "_channel_ref", "=", "None" ]
Close the channel if open.
[ "Close", "the", "channel", "if", "open", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pikachu.py#L157-L161
ask/carrot
carrot/backends/pikachu.py
SyncBackend.prepare_message
def prepare_message(self, message_data, delivery_mode, priority=None, content_type=None, content_encoding=None): """Encapsulate data into a AMQP message.""" properties = pika.BasicProperties(priority=priority, content_type=content_type, ...
python
def prepare_message(self, message_data, delivery_mode, priority=None, content_type=None, content_encoding=None): """Encapsulate data into a AMQP message.""" properties = pika.BasicProperties(priority=priority, content_type=content_type, ...
[ "def", "prepare_message", "(", "self", ",", "message_data", ",", "delivery_mode", ",", "priority", "=", "None", ",", "content_type", "=", "None", ",", "content_encoding", "=", "None", ")", ":", "properties", "=", "pika", ".", "BasicProperties", "(", "priority"...
Encapsulate data into a AMQP message.
[ "Encapsulate", "data", "into", "a", "AMQP", "message", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pikachu.py#L175-L182
ask/carrot
carrot/backends/pikachu.py
SyncBackend.publish
def publish(self, message, exchange, routing_key, mandatory=None, immediate=None, headers=None): """Publish a message to a named exchange.""" body, properties = message if headers: properties.headers = headers ret = self.channel.basic_publish(body=body, ...
python
def publish(self, message, exchange, routing_key, mandatory=None, immediate=None, headers=None): """Publish a message to a named exchange.""" body, properties = message if headers: properties.headers = headers ret = self.channel.basic_publish(body=body, ...
[ "def", "publish", "(", "self", ",", "message", ",", "exchange", ",", "routing_key", ",", "mandatory", "=", "None", ",", "immediate", "=", "None", ",", "headers", "=", "None", ")", ":", "body", ",", "properties", "=", "message", "if", "headers", ":", "p...
Publish a message to a named exchange.
[ "Publish", "a", "message", "to", "a", "named", "exchange", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/backends/pikachu.py#L184-L199
ask/carrot
carrot/messaging.py
Consumer._generate_consumer_tag
def _generate_consumer_tag(self): """Generate a unique consumer tag. :rtype string: """ return "%s.%s%s" % ( self.__class__.__module__, self.__class__.__name__, self._next_consumer_tag())
python
def _generate_consumer_tag(self): """Generate a unique consumer tag. :rtype string: """ return "%s.%s%s" % ( self.__class__.__module__, self.__class__.__name__, self._next_consumer_tag())
[ "def", "_generate_consumer_tag", "(", "self", ")", ":", "return", "\"%s.%s%s\"", "%", "(", "self", ".", "__class__", ".", "__module__", ",", "self", ".", "__class__", ".", "__name__", ",", "self", ".", "_next_consumer_tag", "(", ")", ")" ]
Generate a unique consumer tag. :rtype string:
[ "Generate", "a", "unique", "consumer", "tag", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L247-L256
ask/carrot
carrot/messaging.py
Consumer.declare
def declare(self): """Declares the queue, the exchange and binds the queue to the exchange.""" arguments = None routing_key = self.routing_key if self.exchange_type == "headers": arguments, routing_key = routing_key, "" if self.queue: self.backend...
python
def declare(self): """Declares the queue, the exchange and binds the queue to the exchange.""" arguments = None routing_key = self.routing_key if self.exchange_type == "headers": arguments, routing_key = routing_key, "" if self.queue: self.backend...
[ "def", "declare", "(", "self", ")", ":", "arguments", "=", "None", "routing_key", "=", "self", ".", "routing_key", "if", "self", ".", "exchange_type", "==", "\"headers\"", ":", "arguments", ",", "routing_key", "=", "routing_key", ",", "\"\"", "if", "self", ...
Declares the queue, the exchange and binds the queue to the exchange.
[ "Declares", "the", "queue", "the", "exchange", "and", "binds", "the", "queue", "to", "the", "exchange", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L258-L283
ask/carrot
carrot/messaging.py
Consumer._receive_callback
def _receive_callback(self, raw_message): """Internal method used when a message is received in consume mode.""" message = self.backend.message_to_python(raw_message) if self.auto_ack and not message.acknowledged: message.ack() self.receive(message.payload, message)
python
def _receive_callback(self, raw_message): """Internal method used when a message is received in consume mode.""" message = self.backend.message_to_python(raw_message) if self.auto_ack and not message.acknowledged: message.ack() self.receive(message.payload, message)
[ "def", "_receive_callback", "(", "self", ",", "raw_message", ")", ":", "message", "=", "self", ".", "backend", ".", "message_to_python", "(", "raw_message", ")", "if", "self", ".", "auto_ack", "and", "not", "message", ".", "acknowledged", ":", "message", "."...
Internal method used when a message is received in consume mode.
[ "Internal", "method", "used", "when", "a", "message", "is", "received", "in", "consume", "mode", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L285-L291
ask/carrot
carrot/messaging.py
Consumer.fetch
def fetch(self, no_ack=None, auto_ack=None, enable_callbacks=False): """Receive the next message waiting on the queue. :returns: A :class:`carrot.backends.base.BaseMessage` instance, or ``None`` if there's no messages to be received. :keyword enable_callbacks: Enable callbacks. The...
python
def fetch(self, no_ack=None, auto_ack=None, enable_callbacks=False): """Receive the next message waiting on the queue. :returns: A :class:`carrot.backends.base.BaseMessage` instance, or ``None`` if there's no messages to be received. :keyword enable_callbacks: Enable callbacks. The...
[ "def", "fetch", "(", "self", ",", "no_ack", "=", "None", ",", "auto_ack", "=", "None", ",", "enable_callbacks", "=", "False", ")", ":", "no_ack", "=", "no_ack", "or", "self", ".", "no_ack", "auto_ack", "=", "auto_ack", "or", "self", ".", "auto_ack", "m...
Receive the next message waiting on the queue. :returns: A :class:`carrot.backends.base.BaseMessage` instance, or ``None`` if there's no messages to be received. :keyword enable_callbacks: Enable callbacks. The message will be processed with all registered callbacks. Default is...
[ "Receive", "the", "next", "message", "waiting", "on", "the", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L293-L313
ask/carrot
carrot/messaging.py
Consumer.receive
def receive(self, message_data, message): """This method is called when a new message is received by running :meth:`wait`, :meth:`process_next` or :meth:`iterqueue`. When a message is received, it passes the message on to the callbacks listed in the :attr:`callbacks` attribute. ...
python
def receive(self, message_data, message): """This method is called when a new message is received by running :meth:`wait`, :meth:`process_next` or :meth:`iterqueue`. When a message is received, it passes the message on to the callbacks listed in the :attr:`callbacks` attribute. ...
[ "def", "receive", "(", "self", ",", "message_data", ",", "message", ")", ":", "if", "not", "self", ".", "callbacks", ":", "raise", "NotImplementedError", "(", "\"No consumer callbacks registered\"", ")", "for", "callback", "in", "self", ".", "callbacks", ":", ...
This method is called when a new message is received by running :meth:`wait`, :meth:`process_next` or :meth:`iterqueue`. When a message is received, it passes the message on to the callbacks listed in the :attr:`callbacks` attribute. You can register callbacks using :meth:`register_call...
[ "This", "method", "is", "called", "when", "a", "new", "message", "is", "received", "by", "running", ":", "meth", ":", "wait", ":", "meth", ":", "process_next", "or", ":", "meth", ":", "iterqueue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L326-L344
ask/carrot
carrot/messaging.py
Consumer.discard_all
def discard_all(self, filterfunc=None): """Discard all waiting messages. :param filterfunc: A filter function to only discard the messages this filter returns. :returns: the number of messages discarded. *WARNING*: All incoming messages will be ignored and not processed. ...
python
def discard_all(self, filterfunc=None): """Discard all waiting messages. :param filterfunc: A filter function to only discard the messages this filter returns. :returns: the number of messages discarded. *WARNING*: All incoming messages will be ignored and not processed. ...
[ "def", "discard_all", "(", "self", ",", "filterfunc", "=", "None", ")", ":", "if", "not", "filterfunc", ":", "return", "self", ".", "backend", ".", "queue_purge", "(", "self", ".", "queue", ")", "if", "self", ".", "no_ack", "or", "self", ".", "auto_ack...
Discard all waiting messages. :param filterfunc: A filter function to only discard the messages this filter returns. :returns: the number of messages discarded. *WARNING*: All incoming messages will be ignored and not processed. Example using filter: >>> def ...
[ "Discard", "all", "waiting", "messages", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L364-L401
ask/carrot
carrot/messaging.py
Consumer.consume
def consume(self, no_ack=None): """Declare consumer.""" no_ack = no_ack or self.no_ack self.backend.declare_consumer(queue=self.queue, no_ack=no_ack, callback=self._receive_callback, consumer_tag=self.consumer_tag, ...
python
def consume(self, no_ack=None): """Declare consumer.""" no_ack = no_ack or self.no_ack self.backend.declare_consumer(queue=self.queue, no_ack=no_ack, callback=self._receive_callback, consumer_tag=self.consumer_tag, ...
[ "def", "consume", "(", "self", ",", "no_ack", "=", "None", ")", ":", "no_ack", "=", "no_ack", "or", "self", ".", "no_ack", "self", ".", "backend", ".", "declare_consumer", "(", "queue", "=", "self", ".", "queue", ",", "no_ack", "=", "no_ack", ",", "c...
Declare consumer.
[ "Declare", "consumer", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L427-L434
ask/carrot
carrot/messaging.py
Consumer.wait
def wait(self, limit=None): """Go into consume mode. Mostly for testing purposes and simple programs, you probably want :meth:`iterconsume` or :meth:`iterqueue` instead. This runs an infinite loop, processing all incoming messages using :meth:`receive` to apply the message to a...
python
def wait(self, limit=None): """Go into consume mode. Mostly for testing purposes and simple programs, you probably want :meth:`iterconsume` or :meth:`iterqueue` instead. This runs an infinite loop, processing all incoming messages using :meth:`receive` to apply the message to a...
[ "def", "wait", "(", "self", ",", "limit", "=", "None", ")", ":", "it", "=", "self", ".", "iterconsume", "(", "limit", ")", "while", "True", ":", "it", ".", "next", "(", ")" ]
Go into consume mode. Mostly for testing purposes and simple programs, you probably want :meth:`iterconsume` or :meth:`iterqueue` instead. This runs an infinite loop, processing all incoming messages using :meth:`receive` to apply the message to all registered callbacks.
[ "Go", "into", "consume", "mode", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L436-L449
ask/carrot
carrot/messaging.py
Consumer.iterqueue
def iterqueue(self, limit=None, infinite=False): """Infinite iterator yielding pending messages, by using synchronous direct access to the queue (``basic_get``). :meth:`iterqueue` is used where synchronous functionality is more important than performance. If you can, use :meth:`itercons...
python
def iterqueue(self, limit=None, infinite=False): """Infinite iterator yielding pending messages, by using synchronous direct access to the queue (``basic_get``). :meth:`iterqueue` is used where synchronous functionality is more important than performance. If you can, use :meth:`itercons...
[ "def", "iterqueue", "(", "self", ",", "limit", "=", "None", ",", "infinite", "=", "False", ")", ":", "for", "items_since_start", "in", "count", "(", ")", ":", "item", "=", "self", ".", "fetch", "(", ")", "if", "(", "not", "infinite", "and", "item", ...
Infinite iterator yielding pending messages, by using synchronous direct access to the queue (``basic_get``). :meth:`iterqueue` is used where synchronous functionality is more important than performance. If you can, use :meth:`iterconsume` instead. :keyword limit: If set, the i...
[ "Infinite", "iterator", "yielding", "pending", "messages", "by", "using", "synchronous", "direct", "access", "to", "the", "queue", "(", "basic_get", ")", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L451-L476
ask/carrot
carrot/messaging.py
Consumer.cancel
def cancel(self): """Cancel a running :meth:`iterconsume` session.""" if self.channel_open: try: self.backend.cancel(self.consumer_tag) except KeyError: pass
python
def cancel(self): """Cancel a running :meth:`iterconsume` session.""" if self.channel_open: try: self.backend.cancel(self.consumer_tag) except KeyError: pass
[ "def", "cancel", "(", "self", ")", ":", "if", "self", ".", "channel_open", ":", "try", ":", "self", ".", "backend", ".", "cancel", "(", "self", ".", "consumer_tag", ")", "except", "KeyError", ":", "pass" ]
Cancel a running :meth:`iterconsume` session.
[ "Cancel", "a", "running", ":", "meth", ":", "iterconsume", "session", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L478-L484
ask/carrot
carrot/messaging.py
Consumer.close
def close(self): """Close the channel to the queue.""" self.cancel() self.backend.close() self._closed = True
python
def close(self): """Close the channel to the queue.""" self.cancel() self.backend.close() self._closed = True
[ "def", "close", "(", "self", ")", ":", "self", ".", "cancel", "(", ")", "self", ".", "backend", ".", "close", "(", ")", "self", ".", "_closed", "=", "True" ]
Close the channel to the queue.
[ "Close", "the", "channel", "to", "the", "queue", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L486-L490
ask/carrot
carrot/messaging.py
Consumer.qos
def qos(self, prefetch_size=0, prefetch_count=0, apply_global=False): """Request specific Quality of Service. This method requests a specific quality of service. The QoS can be specified for the current channel or for all channels on the connection. The particular properties and seman...
python
def qos(self, prefetch_size=0, prefetch_count=0, apply_global=False): """Request specific Quality of Service. This method requests a specific quality of service. The QoS can be specified for the current channel or for all channels on the connection. The particular properties and seman...
[ "def", "qos", "(", "self", ",", "prefetch_size", "=", "0", ",", "prefetch_count", "=", "0", ",", "apply_global", "=", "False", ")", ":", "return", "self", ".", "backend", ".", "qos", "(", "prefetch_size", ",", "prefetch_count", ",", "apply_global", ")" ]
Request specific Quality of Service. This method requests a specific quality of service. The QoS can be specified for the current channel or for all channels on the connection. The particular properties and semantics of a qos method always depend on the content class semantics. ...
[ "Request", "specific", "Quality", "of", "Service", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L507-L544
ask/carrot
carrot/messaging.py
Publisher.declare
def declare(self): """Declare the exchange. Creates the exchange on the broker. """ self.backend.exchange_declare(exchange=self.exchange, type=self.exchange_type, durable=self.durable, ...
python
def declare(self): """Declare the exchange. Creates the exchange on the broker. """ self.backend.exchange_declare(exchange=self.exchange, type=self.exchange_type, durable=self.durable, ...
[ "def", "declare", "(", "self", ")", ":", "self", ".", "backend", ".", "exchange_declare", "(", "exchange", "=", "self", ".", "exchange", ",", "type", "=", "self", ".", "exchange_type", ",", "durable", "=", "self", ".", "durable", ",", "auto_delete", "=",...
Declare the exchange. Creates the exchange on the broker.
[ "Declare", "the", "exchange", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L663-L672
ask/carrot
carrot/messaging.py
Publisher.create_message
def create_message(self, message_data, delivery_mode=None, priority=None, content_type=None, content_encoding=None, serializer=None): """With any data, serialize it and encapsulate it in a AMQP message with the proper headers set.""" delivery_mode =...
python
def create_message(self, message_data, delivery_mode=None, priority=None, content_type=None, content_encoding=None, serializer=None): """With any data, serialize it and encapsulate it in a AMQP message with the proper headers set.""" delivery_mode =...
[ "def", "create_message", "(", "self", ",", "message_data", ",", "delivery_mode", "=", "None", ",", "priority", "=", "None", ",", "content_type", "=", "None", ",", "content_encoding", "=", "None", ",", "serializer", "=", "None", ")", ":", "delivery_mode", "="...
With any data, serialize it and encapsulate it in a AMQP message with the proper headers set.
[ "With", "any", "data", "serialize", "it", "and", "encapsulate", "it", "in", "a", "AMQP", "message", "with", "the", "proper", "headers", "set", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L680-L710
ask/carrot
carrot/messaging.py
Publisher.send
def send(self, message_data, routing_key=None, delivery_mode=None, mandatory=False, immediate=False, priority=0, content_type=None, content_encoding=None, serializer=None, exchange=None): """Send a message. :param message_data: The message data to send. Can be a list, ...
python
def send(self, message_data, routing_key=None, delivery_mode=None, mandatory=False, immediate=False, priority=0, content_type=None, content_encoding=None, serializer=None, exchange=None): """Send a message. :param message_data: The message data to send. Can be a list, ...
[ "def", "send", "(", "self", ",", "message_data", ",", "routing_key", "=", "None", ",", "delivery_mode", "=", "None", ",", "mandatory", "=", "False", ",", "immediate", "=", "False", ",", "priority", "=", "0", ",", "content_type", "=", "None", ",", "conten...
Send a message. :param message_data: The message data to send. Can be a list, dictionary or a string. :keyword routing_key: A custom routing key for the message. If not set, the default routing key set in the :attr:`routing_key` attribute is used. :keyword ...
[ "Send", "a", "message", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L712-L772
ask/carrot
carrot/messaging.py
Messaging.send
def send(self, message_data, delivery_mode=None): """See :meth:`Publisher.send`""" self.publisher.send(message_data, delivery_mode=delivery_mode)
python
def send(self, message_data, delivery_mode=None): """See :meth:`Publisher.send`""" self.publisher.send(message_data, delivery_mode=delivery_mode)
[ "def", "send", "(", "self", ",", "message_data", ",", "delivery_mode", "=", "None", ")", ":", "self", ".", "publisher", ".", "send", "(", "message_data", ",", "delivery_mode", "=", "delivery_mode", ")" ]
See :meth:`Publisher.send`
[ "See", ":", "meth", ":", "Publisher", ".", "send" ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L821-L823
ask/carrot
carrot/messaging.py
Messaging.close
def close(self): """Close any open channels.""" self.consumer.close() self.publisher.close() self._closed = True
python
def close(self): """Close any open channels.""" self.consumer.close() self.publisher.close() self._closed = True
[ "def", "close", "(", "self", ")", ":", "self", ".", "consumer", ".", "close", "(", ")", "self", ".", "publisher", ".", "close", "(", ")", "self", ".", "_closed", "=", "True" ]
Close any open channels.
[ "Close", "any", "open", "channels", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L829-L833
ask/carrot
carrot/messaging.py
ConsumerSet._receive_callback
def _receive_callback(self, raw_message): """Internal method used when a message is received in consume mode.""" message = self.backend.message_to_python(raw_message) if self.auto_ack and not message.acknowledged: message.ack() try: decoded = message.decode() ...
python
def _receive_callback(self, raw_message): """Internal method used when a message is received in consume mode.""" message = self.backend.message_to_python(raw_message) if self.auto_ack and not message.acknowledged: message.ack() try: decoded = message.decode() ...
[ "def", "_receive_callback", "(", "self", ",", "raw_message", ")", ":", "message", "=", "self", ".", "backend", ".", "message_to_python", "(", "raw_message", ")", "if", "self", ".", "auto_ack", "and", "not", "message", ".", "acknowledged", ":", "message", "."...
Internal method used when a message is received in consume mode.
[ "Internal", "method", "used", "when", "a", "message", "is", "received", "in", "consume", "mode", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L914-L926
ask/carrot
carrot/messaging.py
ConsumerSet.add_consumer_from_dict
def add_consumer_from_dict(self, queue, **options): """Add another consumer from dictionary configuration.""" options.setdefault("routing_key", options.pop("binding_key", None)) consumer = Consumer(self.connection, queue=queue, backend=self.backend, **options) ...
python
def add_consumer_from_dict(self, queue, **options): """Add another consumer from dictionary configuration.""" options.setdefault("routing_key", options.pop("binding_key", None)) consumer = Consumer(self.connection, queue=queue, backend=self.backend, **options) ...
[ "def", "add_consumer_from_dict", "(", "self", ",", "queue", ",", "*", "*", "options", ")", ":", "options", ".", "setdefault", "(", "\"routing_key\"", ",", "options", ".", "pop", "(", "\"binding_key\"", ",", "None", ")", ")", "consumer", "=", "Consumer", "(...
Add another consumer from dictionary configuration.
[ "Add", "another", "consumer", "from", "dictionary", "configuration", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L928-L934
ask/carrot
carrot/messaging.py
ConsumerSet.add_consumer
def add_consumer(self, consumer): """Add another consumer from a :class:`Consumer` instance.""" consumer.backend = self.backend self.consumers.append(consumer)
python
def add_consumer(self, consumer): """Add another consumer from a :class:`Consumer` instance.""" consumer.backend = self.backend self.consumers.append(consumer)
[ "def", "add_consumer", "(", "self", ",", "consumer", ")", ":", "consumer", ".", "backend", "=", "self", ".", "backend", "self", ".", "consumers", ".", "append", "(", "consumer", ")" ]
Add another consumer from a :class:`Consumer` instance.
[ "Add", "another", "consumer", "from", "a", ":", "class", ":", "Consumer", "instance", "." ]
train
https://github.com/ask/carrot/blob/5889a25cd2e274642071c9bba39772f4b3e3d9da/carrot/messaging.py#L936-L939