partition stringclasses 3
values | func_name stringlengths 1 134 | docstring stringlengths 1 46.9k | path stringlengths 4 223 | original_string stringlengths 75 104k | code stringlengths 75 104k | docstring_tokens listlengths 1 1.97k | repo stringlengths 7 55 | language stringclasses 1
value | url stringlengths 87 315 | code_tokens listlengths 19 28.4k | sha stringlengths 40 40 |
|---|---|---|---|---|---|---|---|---|---|---|---|
valid | _load_class | Loads the class from the class_path string | search/utils.py | def _load_class(class_path, default):
""" Loads the class from the class_path string """
if class_path is None:
return default
component = class_path.rsplit('.', 1)
result_processor = getattr(
importlib.import_module(component[0]),
component[1],
default
) if len(comp... | def _load_class(class_path, default):
""" Loads the class from the class_path string """
if class_path is None:
return default
component = class_path.rsplit('.', 1)
result_processor = getattr(
importlib.import_module(component[0]),
component[1],
default
) if len(comp... | [
"Loads",
"the",
"class",
"from",
"the",
"class_path",
"string"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/utils.py#L8-L20 | [
"def",
"_load_class",
"(",
"class_path",
",",
"default",
")",
":",
"if",
"class_path",
"is",
"None",
":",
"return",
"default",
"component",
"=",
"class_path",
".",
"rsplit",
"(",
"'.'",
",",
"1",
")",
"result_processor",
"=",
"getattr",
"(",
"importlib",
"... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _is_iterable | Checks if an item is iterable (list, tuple, generator), but not string | search/utils.py | def _is_iterable(item):
""" Checks if an item is iterable (list, tuple, generator), but not string """
return isinstance(item, collections.Iterable) and not isinstance(item, six.string_types) | def _is_iterable(item):
""" Checks if an item is iterable (list, tuple, generator), but not string """
return isinstance(item, collections.Iterable) and not isinstance(item, six.string_types) | [
"Checks",
"if",
"an",
"item",
"is",
"iterable",
"(",
"list",
"tuple",
"generator",
")",
"but",
"not",
"string"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/utils.py#L23-L25 | [
"def",
"_is_iterable",
"(",
"item",
")",
":",
"return",
"isinstance",
"(",
"item",
",",
"collections",
".",
"Iterable",
")",
"and",
"not",
"isinstance",
"(",
"item",
",",
"six",
".",
"string_types",
")"
] | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _process_pagination_values | process pagination requests from request parameter | search/views.py | def _process_pagination_values(request):
""" process pagination requests from request parameter """
size = 20
page = 0
from_ = 0
if "page_size" in request.POST:
size = int(request.POST["page_size"])
max_page_size = getattr(settings, "SEARCH_MAX_PAGE_SIZE", 100)
# The parens b... | def _process_pagination_values(request):
""" process pagination requests from request parameter """
size = 20
page = 0
from_ = 0
if "page_size" in request.POST:
size = int(request.POST["page_size"])
max_page_size = getattr(settings, "SEARCH_MAX_PAGE_SIZE", 100)
# The parens b... | [
"process",
"pagination",
"requests",
"from",
"request",
"parameter"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/views.py#L21-L36 | [
"def",
"_process_pagination_values",
"(",
"request",
")",
":",
"size",
"=",
"20",
"page",
"=",
"0",
"from_",
"=",
"0",
"if",
"\"page_size\"",
"in",
"request",
".",
"POST",
":",
"size",
"=",
"int",
"(",
"request",
".",
"POST",
"[",
"\"page_size\"",
"]",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _process_field_values | Create separate dictionary of supported filter values provided | search/views.py | def _process_field_values(request):
""" Create separate dictionary of supported filter values provided """
return {
field_key: request.POST[field_key]
for field_key in request.POST
if field_key in course_discovery_filter_fields()
} | def _process_field_values(request):
""" Create separate dictionary of supported filter values provided """
return {
field_key: request.POST[field_key]
for field_key in request.POST
if field_key in course_discovery_filter_fields()
} | [
"Create",
"separate",
"dictionary",
"of",
"supported",
"filter",
"values",
"provided"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/views.py#L39-L45 | [
"def",
"_process_field_values",
"(",
"request",
")",
":",
"return",
"{",
"field_key",
":",
"request",
".",
"POST",
"[",
"field_key",
"]",
"for",
"field_key",
"in",
"request",
".",
"POST",
"if",
"field_key",
"in",
"course_discovery_filter_fields",
"(",
")",
"}"... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | do_search | Search view for http requests
Args:
request (required) - django request object
course_id (optional) - course_id within which to restrict search
Returns:
http json response with the following fields
"took" - how many seconds the operation took
"total" - how many ... | search/views.py | def do_search(request, course_id=None):
"""
Search view for http requests
Args:
request (required) - django request object
course_id (optional) - course_id within which to restrict search
Returns:
http json response with the following fields
"took" - how many second... | def do_search(request, course_id=None):
"""
Search view for http requests
Args:
request (required) - django request object
course_id (optional) - course_id within which to restrict search
Returns:
http json response with the following fields
"took" - how many second... | [
"Search",
"view",
"for",
"http",
"requests"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/views.py#L49-L144 | [
"def",
"do_search",
"(",
"request",
",",
"course_id",
"=",
"None",
")",
":",
"# Setup search environment",
"SearchInitializer",
".",
"set_search_enviroment",
"(",
"request",
"=",
"request",
",",
"course_id",
"=",
"course_id",
")",
"results",
"=",
"{",
"\"error\"",... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | course_discovery | Search for courses
Args:
request (required) - django request object
Returns:
http json response with the following fields
"took" - how many seconds the operation took
"total" - how many results were found
"max_score" - maximum score from these resutls
... | search/views.py | def course_discovery(request):
"""
Search for courses
Args:
request (required) - django request object
Returns:
http json response with the following fields
"took" - how many seconds the operation took
"total" - how many results were found
"max_score... | def course_discovery(request):
"""
Search for courses
Args:
request (required) - django request object
Returns:
http json response with the following fields
"took" - how many seconds the operation took
"total" - how many results were found
"max_score... | [
"Search",
"for",
"courses"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/views.py#L148-L235 | [
"def",
"course_discovery",
"(",
"request",
")",
":",
"results",
"=",
"{",
"\"error\"",
":",
"_",
"(",
"\"Nothing to search\"",
")",
"}",
"status_code",
"=",
"500",
"search_term",
"=",
"request",
".",
"POST",
".",
"get",
"(",
"\"search_string\"",
",",
"None",... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _translate_hits | Provide resultset in our desired format from elasticsearch results | search/elastic.py | def _translate_hits(es_response):
""" Provide resultset in our desired format from elasticsearch results """
def translate_result(result):
""" Any conversion from ES result syntax into our search engine syntax """
translated_result = copy.copy(result)
data = translated_result.pop("_sour... | def _translate_hits(es_response):
""" Provide resultset in our desired format from elasticsearch results """
def translate_result(result):
""" Any conversion from ES result syntax into our search engine syntax """
translated_result = copy.copy(result)
data = translated_result.pop("_sour... | [
"Provide",
"resultset",
"in",
"our",
"desired",
"format",
"from",
"elasticsearch",
"results"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L26-L61 | [
"def",
"_translate_hits",
"(",
"es_response",
")",
":",
"def",
"translate_result",
"(",
"result",
")",
":",
"\"\"\" Any conversion from ES result syntax into our search engine syntax \"\"\"",
"translated_result",
"=",
"copy",
".",
"copy",
"(",
"result",
")",
"data",
"=",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _get_filter_field | Return field to apply into filter, if an array then use a range, otherwise look for a term match | search/elastic.py | def _get_filter_field(field_name, field_value):
""" Return field to apply into filter, if an array then use a range, otherwise look for a term match """
filter_field = None
if isinstance(field_value, ValueRange):
range_values = {}
if field_value.lower:
range_values.update({"gte":... | def _get_filter_field(field_name, field_value):
""" Return field to apply into filter, if an array then use a range, otherwise look for a term match """
filter_field = None
if isinstance(field_value, ValueRange):
range_values = {}
if field_value.lower:
range_values.update({"gte":... | [
"Return",
"field",
"to",
"apply",
"into",
"filter",
"if",
"an",
"array",
"then",
"use",
"a",
"range",
"otherwise",
"look",
"for",
"a",
"term",
"match"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L64-L90 | [
"def",
"_get_filter_field",
"(",
"field_name",
",",
"field_value",
")",
":",
"filter_field",
"=",
"None",
"if",
"isinstance",
"(",
"field_value",
",",
"ValueRange",
")",
":",
"range_values",
"=",
"{",
"}",
"if",
"field_value",
".",
"lower",
":",
"range_values"... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _process_field_queries | We have a field_dictionary - we want to match the values for an elasticsearch "match" query
This is only potentially useful when trying to tune certain search operations | search/elastic.py | def _process_field_queries(field_dictionary):
"""
We have a field_dictionary - we want to match the values for an elasticsearch "match" query
This is only potentially useful when trying to tune certain search operations
"""
def field_item(field):
""" format field match as "match" item for el... | def _process_field_queries(field_dictionary):
"""
We have a field_dictionary - we want to match the values for an elasticsearch "match" query
This is only potentially useful when trying to tune certain search operations
"""
def field_item(field):
""" format field match as "match" item for el... | [
"We",
"have",
"a",
"field_dictionary",
"-",
"we",
"want",
"to",
"match",
"the",
"values",
"for",
"an",
"elasticsearch",
"match",
"query",
"This",
"is",
"only",
"potentially",
"useful",
"when",
"trying",
"to",
"tune",
"certain",
"search",
"operations"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L93-L106 | [
"def",
"_process_field_queries",
"(",
"field_dictionary",
")",
":",
"def",
"field_item",
"(",
"field",
")",
":",
"\"\"\" format field match as \"match\" item for elasticsearch query \"\"\"",
"return",
"{",
"\"match\"",
":",
"{",
"field",
":",
"field_dictionary",
"[",
"fie... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _process_filters | We have a filter_dictionary - this means that if the field is included
and matches, then we can include, OR if the field is undefined, then we
assume it is safe to include | search/elastic.py | def _process_filters(filter_dictionary):
"""
We have a filter_dictionary - this means that if the field is included
and matches, then we can include, OR if the field is undefined, then we
assume it is safe to include
"""
def filter_item(field):
""" format elasticsearch filter to pass if ... | def _process_filters(filter_dictionary):
"""
We have a filter_dictionary - this means that if the field is included
and matches, then we can include, OR if the field is undefined, then we
assume it is safe to include
"""
def filter_item(field):
""" format elasticsearch filter to pass if ... | [
"We",
"have",
"a",
"filter_dictionary",
"-",
"this",
"means",
"that",
"if",
"the",
"field",
"is",
"included",
"and",
"matches",
"then",
"we",
"can",
"include",
"OR",
"if",
"the",
"field",
"is",
"undefined",
"then",
"we",
"assume",
"it",
"is",
"safe",
"to... | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L116-L142 | [
"def",
"_process_filters",
"(",
"filter_dictionary",
")",
":",
"def",
"filter_item",
"(",
"field",
")",
":",
"\"\"\" format elasticsearch filter to pass if value matches OR field is not included \"\"\"",
"if",
"filter_dictionary",
"[",
"field",
"]",
"is",
"not",
"None",
":"... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _process_exclude_dictionary | Based on values in the exclude_dictionary generate a list of term queries that
will filter out unwanted results. | search/elastic.py | def _process_exclude_dictionary(exclude_dictionary):
"""
Based on values in the exclude_dictionary generate a list of term queries that
will filter out unwanted results.
"""
# not_properties will hold the generated term queries.
not_properties = []
for exclude_property in exclude_dictionary:... | def _process_exclude_dictionary(exclude_dictionary):
"""
Based on values in the exclude_dictionary generate a list of term queries that
will filter out unwanted results.
"""
# not_properties will hold the generated term queries.
not_properties = []
for exclude_property in exclude_dictionary:... | [
"Based",
"on",
"values",
"in",
"the",
"exclude_dictionary",
"generate",
"a",
"list",
"of",
"term",
"queries",
"that",
"will",
"filter",
"out",
"unwanted",
"results",
"."
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L145-L169 | [
"def",
"_process_exclude_dictionary",
"(",
"exclude_dictionary",
")",
":",
"# not_properties will hold the generated term queries.",
"not_properties",
"=",
"[",
"]",
"for",
"exclude_property",
"in",
"exclude_dictionary",
":",
"exclude_values",
"=",
"exclude_dictionary",
"[",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | _process_facet_terms | We have a list of terms with which we return facets | search/elastic.py | def _process_facet_terms(facet_terms):
""" We have a list of terms with which we return facets """
elastic_facets = {}
for facet in facet_terms:
facet_term = {"field": facet}
if facet_terms[facet]:
for facet_option in facet_terms[facet]:
facet_term[facet_option] =... | def _process_facet_terms(facet_terms):
""" We have a list of terms with which we return facets """
elastic_facets = {}
for facet in facet_terms:
facet_term = {"field": facet}
if facet_terms[facet]:
for facet_option in facet_terms[facet]:
facet_term[facet_option] =... | [
"We",
"have",
"a",
"list",
"of",
"terms",
"with",
"which",
"we",
"return",
"facets"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L172-L185 | [
"def",
"_process_facet_terms",
"(",
"facet_terms",
")",
":",
"elastic_facets",
"=",
"{",
"}",
"for",
"facet",
"in",
"facet_terms",
":",
"facet_term",
"=",
"{",
"\"field\"",
":",
"facet",
"}",
"if",
"facet_terms",
"[",
"facet",
"]",
":",
"for",
"facet_option"... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine.get_mappings | fetch mapped-items structure from cache | search/elastic.py | def get_mappings(cls, index_name, doc_type):
""" fetch mapped-items structure from cache """
return cache.get(cls.get_cache_item_name(index_name, doc_type), {}) | def get_mappings(cls, index_name, doc_type):
""" fetch mapped-items structure from cache """
return cache.get(cls.get_cache_item_name(index_name, doc_type), {}) | [
"fetch",
"mapped",
"-",
"items",
"structure",
"from",
"cache"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L201-L203 | [
"def",
"get_mappings",
"(",
"cls",
",",
"index_name",
",",
"doc_type",
")",
":",
"return",
"cache",
".",
"get",
"(",
"cls",
".",
"get_cache_item_name",
"(",
"index_name",
",",
"doc_type",
")",
",",
"{",
"}",
")"
] | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine.set_mappings | set new mapped-items structure into cache | search/elastic.py | def set_mappings(cls, index_name, doc_type, mappings):
""" set new mapped-items structure into cache """
cache.set(cls.get_cache_item_name(index_name, doc_type), mappings) | def set_mappings(cls, index_name, doc_type, mappings):
""" set new mapped-items structure into cache """
cache.set(cls.get_cache_item_name(index_name, doc_type), mappings) | [
"set",
"new",
"mapped",
"-",
"items",
"structure",
"into",
"cache"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L206-L208 | [
"def",
"set_mappings",
"(",
"cls",
",",
"index_name",
",",
"doc_type",
",",
"mappings",
")",
":",
"cache",
".",
"set",
"(",
"cls",
".",
"get_cache_item_name",
"(",
"index_name",
",",
"doc_type",
")",
",",
"mappings",
")"
] | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine.log_indexing_error | Logs indexing errors and raises a general ElasticSearch Exception | search/elastic.py | def log_indexing_error(cls, indexing_errors):
""" Logs indexing errors and raises a general ElasticSearch Exception"""
indexing_errors_log = []
for indexing_error in indexing_errors:
indexing_errors_log.append(str(indexing_error))
raise exceptions.ElasticsearchException(', '.... | def log_indexing_error(cls, indexing_errors):
""" Logs indexing errors and raises a general ElasticSearch Exception"""
indexing_errors_log = []
for indexing_error in indexing_errors:
indexing_errors_log.append(str(indexing_error))
raise exceptions.ElasticsearchException(', '.... | [
"Logs",
"indexing",
"errors",
"and",
"raises",
"a",
"general",
"ElasticSearch",
"Exception"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L211-L216 | [
"def",
"log_indexing_error",
"(",
"cls",
",",
"indexing_errors",
")",
":",
"indexing_errors_log",
"=",
"[",
"]",
"for",
"indexing_error",
"in",
"indexing_errors",
":",
"indexing_errors_log",
".",
"append",
"(",
"str",
"(",
"indexing_error",
")",
")",
"raise",
"e... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine._get_mappings | Interfaces with the elasticsearch mappings for the index
prevents multiple loading of the same mappings from ES when called more than once
Mappings format in elasticsearch is as follows:
{
"doc_type": {
"properties": {
"nested_property": {
... | search/elastic.py | def _get_mappings(self, doc_type):
"""
Interfaces with the elasticsearch mappings for the index
prevents multiple loading of the same mappings from ES when called more than once
Mappings format in elasticsearch is as follows:
{
"doc_type": {
"properties"... | def _get_mappings(self, doc_type):
"""
Interfaces with the elasticsearch mappings for the index
prevents multiple loading of the same mappings from ES when called more than once
Mappings format in elasticsearch is as follows:
{
"doc_type": {
"properties"... | [
"Interfaces",
"with",
"the",
"elasticsearch",
"mappings",
"for",
"the",
"index",
"prevents",
"multiple",
"loading",
"of",
"the",
"same",
"mappings",
"from",
"ES",
"when",
"called",
"more",
"than",
"once"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L218-L268 | [
"def",
"_get_mappings",
"(",
"self",
",",
"doc_type",
")",
":",
"# Try loading the mapping from the cache.",
"mapping",
"=",
"ElasticSearchEngine",
".",
"get_mappings",
"(",
"self",
".",
"index_name",
",",
"doc_type",
")",
"# Fall back to Elasticsearch",
"if",
"not",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine._check_mappings | We desire to index content so that anything we want to be textually searchable(and therefore needing to be
analysed), but the other fields are designed to be filters, and only require an exact match. So, we want to
set up the mappings for these fields as "not_analyzed" - this will allow our filters to w... | search/elastic.py | def _check_mappings(self, doc_type, body):
"""
We desire to index content so that anything we want to be textually searchable(and therefore needing to be
analysed), but the other fields are designed to be filters, and only require an exact match. So, we want to
set up the mappings for th... | def _check_mappings(self, doc_type, body):
"""
We desire to index content so that anything we want to be textually searchable(and therefore needing to be
analysed), but the other fields are designed to be filters, and only require an exact match. So, we want to
set up the mappings for th... | [
"We",
"desire",
"to",
"index",
"content",
"so",
"that",
"anything",
"we",
"want",
"to",
"be",
"textually",
"searchable",
"(",
"and",
"therefore",
"needing",
"to",
"be",
"analysed",
")",
"but",
"the",
"other",
"fields",
"are",
"designed",
"to",
"be",
"filte... | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L281-L355 | [
"def",
"_check_mappings",
"(",
"self",
",",
"doc_type",
",",
"body",
")",
":",
"# Make fields other than content be indexed as unanalyzed terms - content",
"# contains fields that are to be analyzed",
"exclude_fields",
"=",
"[",
"\"content\"",
"]",
"field_properties",
"=",
"get... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine.index | Implements call to add documents to the ES index
Note the call to _check_mappings which will setup fields with the desired mappings | search/elastic.py | def index(self, doc_type, sources, **kwargs):
"""
Implements call to add documents to the ES index
Note the call to _check_mappings which will setup fields with the desired mappings
"""
try:
actions = []
for source in sources:
self._check_... | def index(self, doc_type, sources, **kwargs):
"""
Implements call to add documents to the ES index
Note the call to _check_mappings which will setup fields with the desired mappings
"""
try:
actions = []
for source in sources:
self._check_... | [
"Implements",
"call",
"to",
"add",
"documents",
"to",
"the",
"ES",
"index",
"Note",
"the",
"call",
"to",
"_check_mappings",
"which",
"will",
"setup",
"fields",
"with",
"the",
"desired",
"mappings"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L357-L389 | [
"def",
"index",
"(",
"self",
",",
"doc_type",
",",
"sources",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"actions",
"=",
"[",
"]",
"for",
"source",
"in",
"sources",
":",
"self",
".",
"_check_mappings",
"(",
"doc_type",
",",
"source",
")",
"id_",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine.remove | Implements call to remove the documents from the index | search/elastic.py | def remove(self, doc_type, doc_ids, **kwargs):
""" Implements call to remove the documents from the index """
try:
# ignore is flagged as an unexpected-keyword-arg; ES python client documents that it can be used
# pylint: disable=unexpected-keyword-arg
actions = []
... | def remove(self, doc_type, doc_ids, **kwargs):
""" Implements call to remove the documents from the index """
try:
# ignore is flagged as an unexpected-keyword-arg; ES python client documents that it can be used
# pylint: disable=unexpected-keyword-arg
actions = []
... | [
"Implements",
"call",
"to",
"remove",
"the",
"documents",
"from",
"the",
"index"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L391-L413 | [
"def",
"remove",
"(",
"self",
",",
"doc_type",
",",
"doc_ids",
",",
"*",
"*",
"kwargs",
")",
":",
"try",
":",
"# ignore is flagged as an unexpected-keyword-arg; ES python client documents that it can be used",
"# pylint: disable=unexpected-keyword-arg",
"actions",
"=",
"[",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | ElasticSearchEngine.search | Implements call to search the index for the desired content.
Args:
query_string (str): the string of values upon which to search within the
content of the objects within the index
field_dictionary (dict): dictionary of values which _must_ exist and
_must_ match ... | search/elastic.py | def search(self,
query_string=None,
field_dictionary=None,
filter_dictionary=None,
exclude_dictionary=None,
facet_terms=None,
exclude_ids=None,
use_field_match=False,
**kwargs): # pylint: disable=too... | def search(self,
query_string=None,
field_dictionary=None,
filter_dictionary=None,
exclude_dictionary=None,
facet_terms=None,
exclude_ids=None,
use_field_match=False,
**kwargs): # pylint: disable=too... | [
"Implements",
"call",
"to",
"search",
"the",
"index",
"for",
"the",
"desired",
"content",
"."
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/elastic.py#L431-L618 | [
"def",
"search",
"(",
"self",
",",
"query_string",
"=",
"None",
",",
"field_dictionary",
"=",
"None",
",",
"filter_dictionary",
"=",
"None",
",",
"exclude_dictionary",
"=",
"None",
",",
"facet_terms",
"=",
"None",
",",
"exclude_ids",
"=",
"None",
",",
"use_f... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchEngine.get_search_engine | Returns the desired implementor (defined in settings) | search/search_engine_base.py | def get_search_engine(index=None):
"""
Returns the desired implementor (defined in settings)
"""
search_engine_class = _load_class(getattr(settings, "SEARCH_ENGINE", None), None)
return search_engine_class(index=index) if search_engine_class else None | def get_search_engine(index=None):
"""
Returns the desired implementor (defined in settings)
"""
search_engine_class = _load_class(getattr(settings, "SEARCH_ENGINE", None), None)
return search_engine_class(index=index) if search_engine_class else None | [
"Returns",
"the",
"desired",
"implementor",
"(",
"defined",
"in",
"settings",
")"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/search_engine_base.py#L46-L51 | [
"def",
"get_search_engine",
"(",
"index",
"=",
"None",
")",
":",
"search_engine_class",
"=",
"_load_class",
"(",
"getattr",
"(",
"settings",
",",
"\"SEARCH_ENGINE\"",
",",
"None",
")",
",",
"None",
")",
"return",
"search_engine_class",
"(",
"index",
"=",
"inde... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | perform_search | Call the search engine with the appropriate parameters | search/api.py | def perform_search(
search_term,
user=None,
size=10,
from_=0,
course_id=None):
""" Call the search engine with the appropriate parameters """
# field_, filter_ and exclude_dictionary(s) can be overridden by calling application
# field_dictionary includes course if cou... | def perform_search(
search_term,
user=None,
size=10,
from_=0,
course_id=None):
""" Call the search engine with the appropriate parameters """
# field_, filter_ and exclude_dictionary(s) can be overridden by calling application
# field_dictionary includes course if cou... | [
"Call",
"the",
"search",
"engine",
"with",
"the",
"appropriate",
"parameters"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/api.py#L42-L77 | [
"def",
"perform_search",
"(",
"search_term",
",",
"user",
"=",
"None",
",",
"size",
"=",
"10",
",",
"from_",
"=",
"0",
",",
"course_id",
"=",
"None",
")",
":",
"# field_, filter_ and exclude_dictionary(s) can be overridden by calling application",
"# field_dictionary in... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | course_discovery_search | Course Discovery activities against the search engine index of course details | search/api.py | def course_discovery_search(search_term=None, size=20, from_=0, field_dictionary=None):
"""
Course Discovery activities against the search engine index of course details
"""
# We'll ignore the course-enrollemnt informaiton in field and filter
# dictionary, and use our own logic upon enrollment dates... | def course_discovery_search(search_term=None, size=20, from_=0, field_dictionary=None):
"""
Course Discovery activities against the search engine index of course details
"""
# We'll ignore the course-enrollemnt informaiton in field and filter
# dictionary, and use our own logic upon enrollment dates... | [
"Course",
"Discovery",
"activities",
"against",
"the",
"search",
"engine",
"index",
"of",
"course",
"details"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/api.py#L80-L112 | [
"def",
"course_discovery_search",
"(",
"search_term",
"=",
"None",
",",
"size",
"=",
"20",
",",
"from_",
"=",
"0",
",",
"field_dictionary",
"=",
"None",
")",
":",
"# We'll ignore the course-enrollemnt informaiton in field and filter",
"# dictionary, and use our own logic up... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchResultProcessor.strings_in_dictionary | Used by default implementation for finding excerpt | search/result_processor.py | def strings_in_dictionary(dictionary):
""" Used by default implementation for finding excerpt """
strings = [value for value in six.itervalues(dictionary) if not isinstance(value, dict)]
for child_dict in [dv for dv in six.itervalues(dictionary) if isinstance(dv, dict)]:
strings.exte... | def strings_in_dictionary(dictionary):
""" Used by default implementation for finding excerpt """
strings = [value for value in six.itervalues(dictionary) if not isinstance(value, dict)]
for child_dict in [dv for dv in six.itervalues(dictionary) if isinstance(dv, dict)]:
strings.exte... | [
"Used",
"by",
"default",
"implementation",
"for",
"finding",
"excerpt"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/result_processor.py#L46-L51 | [
"def",
"strings_in_dictionary",
"(",
"dictionary",
")",
":",
"strings",
"=",
"[",
"value",
"for",
"value",
"in",
"six",
".",
"itervalues",
"(",
"dictionary",
")",
"if",
"not",
"isinstance",
"(",
"value",
",",
"dict",
")",
"]",
"for",
"child_dict",
"in",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchResultProcessor.find_matches | Used by default property excerpt | search/result_processor.py | def find_matches(strings, words, length_hoped):
""" Used by default property excerpt """
lower_words = [w.lower() for w in words]
def has_match(string):
""" Do any of the words match within the string """
lower_string = string.lower()
for test_word in lower_w... | def find_matches(strings, words, length_hoped):
""" Used by default property excerpt """
lower_words = [w.lower() for w in words]
def has_match(string):
""" Do any of the words match within the string """
lower_string = string.lower()
for test_word in lower_w... | [
"Used",
"by",
"default",
"property",
"excerpt"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/result_processor.py#L54-L78 | [
"def",
"find_matches",
"(",
"strings",
",",
"words",
",",
"length_hoped",
")",
":",
"lower_words",
"=",
"[",
"w",
".",
"lower",
"(",
")",
"for",
"w",
"in",
"words",
"]",
"def",
"has_match",
"(",
"string",
")",
":",
"\"\"\" Do any of the words match within th... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchResultProcessor.decorate_matches | decorate the matches within the excerpt | search/result_processor.py | def decorate_matches(match_in, match_word):
""" decorate the matches within the excerpt """
matches = re.finditer(match_word, match_in, re.IGNORECASE)
for matched_string in set([match.group() for match in matches]):
match_in = match_in.replace(
matched_string,
... | def decorate_matches(match_in, match_word):
""" decorate the matches within the excerpt """
matches = re.finditer(match_word, match_in, re.IGNORECASE)
for matched_string in set([match.group() for match in matches]):
match_in = match_in.replace(
matched_string,
... | [
"decorate",
"the",
"matches",
"within",
"the",
"excerpt"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/result_processor.py#L81-L89 | [
"def",
"decorate_matches",
"(",
"match_in",
",",
"match_word",
")",
":",
"matches",
"=",
"re",
".",
"finditer",
"(",
"match_word",
",",
"match_in",
",",
"re",
".",
"IGNORECASE",
")",
"for",
"matched_string",
"in",
"set",
"(",
"[",
"match",
".",
"group",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchResultProcessor.add_properties | Called during post processing of result
Any properties defined in your subclass will get exposed as members of the result json from the search | search/result_processor.py | def add_properties(self):
"""
Called during post processing of result
Any properties defined in your subclass will get exposed as members of the result json from the search
"""
for property_name in [p[0] for p in inspect.getmembers(self.__class__) if isinstance(p[1], property)]:
... | def add_properties(self):
"""
Called during post processing of result
Any properties defined in your subclass will get exposed as members of the result json from the search
"""
for property_name in [p[0] for p in inspect.getmembers(self.__class__) if isinstance(p[1], property)]:
... | [
"Called",
"during",
"post",
"processing",
"of",
"result",
"Any",
"properties",
"defined",
"in",
"your",
"subclass",
"will",
"get",
"exposed",
"as",
"members",
"of",
"the",
"result",
"json",
"from",
"the",
"search"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/result_processor.py#L99-L105 | [
"def",
"add_properties",
"(",
"self",
")",
":",
"for",
"property_name",
"in",
"[",
"p",
"[",
"0",
"]",
"for",
"p",
"in",
"inspect",
".",
"getmembers",
"(",
"self",
".",
"__class__",
")",
"if",
"isinstance",
"(",
"p",
"[",
"1",
"]",
",",
"property",
... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchResultProcessor.process_result | Called from within search handler. Finds desired subclass and decides if the
result should be removed and adds properties derived from the result information | search/result_processor.py | def process_result(cls, dictionary, match_phrase, user):
"""
Called from within search handler. Finds desired subclass and decides if the
result should be removed and adds properties derived from the result information
"""
result_processor = _load_class(getattr(settings, "SEARCH_... | def process_result(cls, dictionary, match_phrase, user):
"""
Called from within search handler. Finds desired subclass and decides if the
result should be removed and adds properties derived from the result information
"""
result_processor = _load_class(getattr(settings, "SEARCH_... | [
"Called",
"from",
"within",
"search",
"handler",
".",
"Finds",
"desired",
"subclass",
"and",
"decides",
"if",
"the",
"result",
"should",
"be",
"removed",
"and",
"adds",
"properties",
"derived",
"from",
"the",
"result",
"information"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/result_processor.py#L108-L124 | [
"def",
"process_result",
"(",
"cls",
",",
"dictionary",
",",
"match_phrase",
",",
"user",
")",
":",
"result_processor",
"=",
"_load_class",
"(",
"getattr",
"(",
"settings",
",",
"\"SEARCH_RESULT_PROCESSOR\"",
",",
"None",
")",
",",
"cls",
")",
"srp",
"=",
"r... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchResultProcessor.excerpt | Property to display a useful excerpt representing the matches within the results | search/result_processor.py | def excerpt(self):
"""
Property to display a useful excerpt representing the matches within the results
"""
if "content" not in self._results_fields:
return None
match_phrases = [self._match_phrase]
if six.PY2:
separate_phrases = [
... | def excerpt(self):
"""
Property to display a useful excerpt representing the matches within the results
"""
if "content" not in self._results_fields:
return None
match_phrases = [self._match_phrase]
if six.PY2:
separate_phrases = [
... | [
"Property",
"to",
"display",
"a",
"useful",
"excerpt",
"representing",
"the",
"matches",
"within",
"the",
"results"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/result_processor.py#L127-L160 | [
"def",
"excerpt",
"(",
"self",
")",
":",
"if",
"\"content\"",
"not",
"in",
"self",
".",
"_results_fields",
":",
"return",
"None",
"match_phrases",
"=",
"[",
"self",
".",
"_match_phrase",
"]",
"if",
"six",
".",
"PY2",
":",
"separate_phrases",
"=",
"[",
"p... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchFilterGenerator.generate_field_filters | Called from within search handler
Finds desired subclass and adds filter information based upon user information | search/filter_generator.py | def generate_field_filters(cls, **kwargs):
"""
Called from within search handler
Finds desired subclass and adds filter information based upon user information
"""
generator = _load_class(getattr(settings, "SEARCH_FILTER_GENERATOR", None), cls)()
return (
gene... | def generate_field_filters(cls, **kwargs):
"""
Called from within search handler
Finds desired subclass and adds filter information based upon user information
"""
generator = _load_class(getattr(settings, "SEARCH_FILTER_GENERATOR", None), cls)()
return (
gene... | [
"Called",
"from",
"within",
"search",
"handler",
"Finds",
"desired",
"subclass",
"and",
"adds",
"filter",
"information",
"based",
"upon",
"user",
"information"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/filter_generator.py#L36-L46 | [
"def",
"generate_field_filters",
"(",
"cls",
",",
"*",
"*",
"kwargs",
")",
":",
"generator",
"=",
"_load_class",
"(",
"getattr",
"(",
"settings",
",",
"\"SEARCH_FILTER_GENERATOR\"",
",",
"None",
")",
",",
"cls",
")",
"(",
")",
"return",
"(",
"generator",
"... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | SearchInitializer.set_search_enviroment | Called from within search handler
Finds desired subclass and calls initialize method | search/initializer.py | def set_search_enviroment(cls, **kwargs):
"""
Called from within search handler
Finds desired subclass and calls initialize method
"""
initializer = _load_class(getattr(settings, "SEARCH_INITIALIZER", None), cls)()
return initializer.initialize(**kwargs) | def set_search_enviroment(cls, **kwargs):
"""
Called from within search handler
Finds desired subclass and calls initialize method
"""
initializer = _load_class(getattr(settings, "SEARCH_INITIALIZER", None), cls)()
return initializer.initialize(**kwargs) | [
"Called",
"from",
"within",
"search",
"handler",
"Finds",
"desired",
"subclass",
"and",
"calls",
"initialize",
"method"
] | edx/edx-search | python | https://github.com/edx/edx-search/blob/476cf02b71ceba34ae7d8b798f36d60692317c55/search/initializer.py#L23-L29 | [
"def",
"set_search_enviroment",
"(",
"cls",
",",
"*",
"*",
"kwargs",
")",
":",
"initializer",
"=",
"_load_class",
"(",
"getattr",
"(",
"settings",
",",
"\"SEARCH_INITIALIZER\"",
",",
"None",
")",
",",
"cls",
")",
"(",
")",
"return",
"initializer",
".",
"in... | 476cf02b71ceba34ae7d8b798f36d60692317c55 |
valid | Detector._parse | Opens data file and for each line, calls _eat_name_line | sexmachine/detector.py | def _parse(self, filename):
"""Opens data file and for each line, calls _eat_name_line"""
self.names = {}
with codecs.open(filename, encoding="iso8859-1") as f:
for line in f:
if any(map(lambda c: 128 < ord(c) < 160, line)):
line = line.encode("iso... | def _parse(self, filename):
"""Opens data file and for each line, calls _eat_name_line"""
self.names = {}
with codecs.open(filename, encoding="iso8859-1") as f:
for line in f:
if any(map(lambda c: 128 < ord(c) < 160, line)):
line = line.encode("iso... | [
"Opens",
"data",
"file",
"and",
"for",
"each",
"line",
"calls",
"_eat_name_line"
] | ferhatelmas/sexmachine | python | https://github.com/ferhatelmas/sexmachine/blob/85d33bb47ccc017676e69788750f116e391f52db/sexmachine/detector.py#L33-L40 | [
"def",
"_parse",
"(",
"self",
",",
"filename",
")",
":",
"self",
".",
"names",
"=",
"{",
"}",
"with",
"codecs",
".",
"open",
"(",
"filename",
",",
"encoding",
"=",
"\"iso8859-1\"",
")",
"as",
"f",
":",
"for",
"line",
"in",
"f",
":",
"if",
"any",
... | 85d33bb47ccc017676e69788750f116e391f52db |
valid | Detector._eat_name_line | Parses one line of data file | sexmachine/detector.py | def _eat_name_line(self, line):
"""Parses one line of data file"""
if line[0] not in "#=":
parts = line.split()
country_values = line[30:-1]
name = map_name(parts[1])
if not self.case_sensitive:
name = name.lower()
if parts[0] ... | def _eat_name_line(self, line):
"""Parses one line of data file"""
if line[0] not in "#=":
parts = line.split()
country_values = line[30:-1]
name = map_name(parts[1])
if not self.case_sensitive:
name = name.lower()
if parts[0] ... | [
"Parses",
"one",
"line",
"of",
"data",
"file"
] | ferhatelmas/sexmachine | python | https://github.com/ferhatelmas/sexmachine/blob/85d33bb47ccc017676e69788750f116e391f52db/sexmachine/detector.py#L42-L62 | [
"def",
"_eat_name_line",
"(",
"self",
",",
"line",
")",
":",
"if",
"line",
"[",
"0",
"]",
"not",
"in",
"\"#=\"",
":",
"parts",
"=",
"line",
".",
"split",
"(",
")",
"country_values",
"=",
"line",
"[",
"30",
":",
"-",
"1",
"]",
"name",
"=",
"map_na... | 85d33bb47ccc017676e69788750f116e391f52db |
valid | Detector._set | Sets gender and relevant country values for names dictionary of detector | sexmachine/detector.py | def _set(self, name, gender, country_values):
"""Sets gender and relevant country values for names dictionary of detector"""
if '+' in name:
for replacement in ['', ' ', '-']:
self._set(name.replace('+', replacement), gender, country_values)
else:
if name ... | def _set(self, name, gender, country_values):
"""Sets gender and relevant country values for names dictionary of detector"""
if '+' in name:
for replacement in ['', ' ', '-']:
self._set(name.replace('+', replacement), gender, country_values)
else:
if name ... | [
"Sets",
"gender",
"and",
"relevant",
"country",
"values",
"for",
"names",
"dictionary",
"of",
"detector"
] | ferhatelmas/sexmachine | python | https://github.com/ferhatelmas/sexmachine/blob/85d33bb47ccc017676e69788750f116e391f52db/sexmachine/detector.py#L64-L72 | [
"def",
"_set",
"(",
"self",
",",
"name",
",",
"gender",
",",
"country_values",
")",
":",
"if",
"'+'",
"in",
"name",
":",
"for",
"replacement",
"in",
"[",
"''",
",",
"' '",
",",
"'-'",
"]",
":",
"self",
".",
"_set",
"(",
"name",
".",
"replace",
"(... | 85d33bb47ccc017676e69788750f116e391f52db |
valid | Detector._most_popular_gender | Finds the most popular gender for the given name counting by given counter | sexmachine/detector.py | def _most_popular_gender(self, name, counter):
"""Finds the most popular gender for the given name counting by given counter"""
if name not in self.names:
return self.unknown_value
max_count, max_tie = (0, 0)
best = self.names[name].keys()[0]
for gender, country_valu... | def _most_popular_gender(self, name, counter):
"""Finds the most popular gender for the given name counting by given counter"""
if name not in self.names:
return self.unknown_value
max_count, max_tie = (0, 0)
best = self.names[name].keys()[0]
for gender, country_valu... | [
"Finds",
"the",
"most",
"popular",
"gender",
"for",
"the",
"given",
"name",
"counting",
"by",
"given",
"counter"
] | ferhatelmas/sexmachine | python | https://github.com/ferhatelmas/sexmachine/blob/85d33bb47ccc017676e69788750f116e391f52db/sexmachine/detector.py#L74-L86 | [
"def",
"_most_popular_gender",
"(",
"self",
",",
"name",
",",
"counter",
")",
":",
"if",
"name",
"not",
"in",
"self",
".",
"names",
":",
"return",
"self",
".",
"unknown_value",
"max_count",
",",
"max_tie",
"=",
"(",
"0",
",",
"0",
")",
"best",
"=",
"... | 85d33bb47ccc017676e69788750f116e391f52db |
valid | Detector.get_gender | Returns best gender for the given name and country pair | sexmachine/detector.py | def get_gender(self, name, country=None):
"""Returns best gender for the given name and country pair"""
if not self.case_sensitive:
name = name.lower()
if name not in self.names:
return self.unknown_value
elif not country:
def counter(country_values):... | def get_gender(self, name, country=None):
"""Returns best gender for the given name and country pair"""
if not self.case_sensitive:
name = name.lower()
if name not in self.names:
return self.unknown_value
elif not country:
def counter(country_values):... | [
"Returns",
"best",
"gender",
"for",
"the",
"given",
"name",
"and",
"country",
"pair"
] | ferhatelmas/sexmachine | python | https://github.com/ferhatelmas/sexmachine/blob/85d33bb47ccc017676e69788750f116e391f52db/sexmachine/detector.py#L88-L106 | [
"def",
"get_gender",
"(",
"self",
",",
"name",
",",
"country",
"=",
"None",
")",
":",
"if",
"not",
"self",
".",
"case_sensitive",
":",
"name",
"=",
"name",
".",
"lower",
"(",
")",
"if",
"name",
"not",
"in",
"self",
".",
"names",
":",
"return",
"sel... | 85d33bb47ccc017676e69788750f116e391f52db |
valid | Report.output | Writes the specified string to the output target of the report.
:param msg: the message to output.
:type msg: str
:param newline:
whether or not to append a newline to the end of the message
:type newline: str | src/tidypy/reports/base.py | def output(self, msg, newline=True):
"""
Writes the specified string to the output target of the report.
:param msg: the message to output.
:type msg: str
:param newline:
whether or not to append a newline to the end of the message
:type newline: str
... | def output(self, msg, newline=True):
"""
Writes the specified string to the output target of the report.
:param msg: the message to output.
:type msg: str
:param newline:
whether or not to append a newline to the end of the message
:type newline: str
... | [
"Writes",
"the",
"specified",
"string",
"to",
"the",
"output",
"target",
"of",
"the",
"report",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/reports/base.py#L64-L75 | [
"def",
"output",
"(",
"self",
",",
"msg",
",",
"newline",
"=",
"True",
")",
":",
"click",
".",
"echo",
"(",
"text_type",
"(",
"msg",
")",
",",
"nl",
"=",
"newline",
",",
"file",
"=",
"self",
".",
"output_file",
")"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | execute_tools | Executes the suite of TidyPy tools upon the project and returns the
issues that are found.
:param config: the TidyPy configuration to use
:type config: dict
:param path: that path to the project to analyze
:type path: str
:param progress:
the progress reporter object that will receive c... | src/tidypy/core.py | def execute_tools(config, path, progress=None):
"""
Executes the suite of TidyPy tools upon the project and returns the
issues that are found.
:param config: the TidyPy configuration to use
:type config: dict
:param path: that path to the project to analyze
:type path: str
:param progre... | def execute_tools(config, path, progress=None):
"""
Executes the suite of TidyPy tools upon the project and returns the
issues that are found.
:param config: the TidyPy configuration to use
:type config: dict
:param path: that path to the project to analyze
:type path: str
:param progre... | [
"Executes",
"the",
"suite",
"of",
"TidyPy",
"tools",
"upon",
"the",
"project",
"and",
"returns",
"the",
"issues",
"that",
"are",
"found",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/core.py#L85-L155 | [
"def",
"execute_tools",
"(",
"config",
",",
"path",
",",
"progress",
"=",
"None",
")",
":",
"progress",
"=",
"progress",
"or",
"QuietProgress",
"(",
")",
"progress",
".",
"on_start",
"(",
")",
"manager",
"=",
"SyncManager",
"(",
")",
"manager",
".",
"sta... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | execute_reports | Executes the configured suite of issue reports.
:param config: the TidyPy configuration to use
:type config: dict
:param path: that path to the project that was analyzed
:type path: str
:param collector: the issues to report
:type collector: tidypy.Collector | src/tidypy/core.py | def execute_reports(
config,
path,
collector,
on_report_finish=None,
output_file=None):
"""
Executes the configured suite of issue reports.
:param config: the TidyPy configuration to use
:type config: dict
:param path: that path to the project that was analyz... | def execute_reports(
config,
path,
collector,
on_report_finish=None,
output_file=None):
"""
Executes the configured suite of issue reports.
:param config: the TidyPy configuration to use
:type config: dict
:param path: that path to the project that was analyz... | [
"Executes",
"the",
"configured",
"suite",
"of",
"issue",
"reports",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/core.py#L158-L187 | [
"def",
"execute_reports",
"(",
"config",
",",
"path",
",",
"collector",
",",
"on_report_finish",
"=",
"None",
",",
"output_file",
"=",
"None",
")",
":",
"reports",
"=",
"get_reports",
"(",
")",
"for",
"report",
"in",
"config",
".",
"get",
"(",
"'requested_... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Finder.is_excluded | Determines whether or not the specified file is excluded by the
project's configuration.
:param path: the path to check
:type path: pathlib.Path
:rtype: bool | src/tidypy/finder.py | def is_excluded(self, path):
"""
Determines whether or not the specified file is excluded by the
project's configuration.
:param path: the path to check
:type path: pathlib.Path
:rtype: bool
"""
relpath = path.relative_to(self.base_path).as_posix()
... | def is_excluded(self, path):
"""
Determines whether or not the specified file is excluded by the
project's configuration.
:param path: the path to check
:type path: pathlib.Path
:rtype: bool
"""
relpath = path.relative_to(self.base_path).as_posix()
... | [
"Determines",
"whether",
"or",
"not",
"the",
"specified",
"file",
"is",
"excluded",
"by",
"the",
"project",
"s",
"configuration",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/finder.py#L76-L87 | [
"def",
"is_excluded",
"(",
"self",
",",
"path",
")",
":",
"relpath",
"=",
"path",
".",
"relative_to",
"(",
"self",
".",
"base_path",
")",
".",
"as_posix",
"(",
")",
"return",
"matches_masks",
"(",
"relpath",
",",
"self",
".",
"excludes",
")"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Finder.is_excluded_dir | Determines whether or not the specified directory is excluded by the
project's configuration.
:param path: the path to check
:type path: pathlib.Path
:rtype: bool | src/tidypy/finder.py | def is_excluded_dir(self, path):
"""
Determines whether or not the specified directory is excluded by the
project's configuration.
:param path: the path to check
:type path: pathlib.Path
:rtype: bool
"""
if self.is_excluded(path):
return True... | def is_excluded_dir(self, path):
"""
Determines whether or not the specified directory is excluded by the
project's configuration.
:param path: the path to check
:type path: pathlib.Path
:rtype: bool
"""
if self.is_excluded(path):
return True... | [
"Determines",
"whether",
"or",
"not",
"the",
"specified",
"directory",
"is",
"excluded",
"by",
"the",
"project",
"s",
"configuration",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/finder.py#L89-L101 | [
"def",
"is_excluded_dir",
"(",
"self",
",",
"path",
")",
":",
"if",
"self",
".",
"is_excluded",
"(",
"path",
")",
":",
"return",
"True",
"return",
"matches_masks",
"(",
"path",
".",
"name",
",",
"ALWAYS_EXCLUDED_DIRS",
")"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Finder.files | A generator that produces a sequence of paths to files in the project
that matches the specified filters.
:param filters:
the regular expressions to use when finding files in the project.
If not specified, all files are returned.
:type filters: list(str) | src/tidypy/finder.py | def files(self, filters=None):
"""
A generator that produces a sequence of paths to files in the project
that matches the specified filters.
:param filters:
the regular expressions to use when finding files in the project.
If not specified, all files are returned... | def files(self, filters=None):
"""
A generator that produces a sequence of paths to files in the project
that matches the specified filters.
:param filters:
the regular expressions to use when finding files in the project.
If not specified, all files are returned... | [
"A",
"generator",
"that",
"produces",
"a",
"sequence",
"of",
"paths",
"to",
"files",
"in",
"the",
"project",
"that",
"matches",
"the",
"specified",
"filters",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/finder.py#L103-L120 | [
"def",
"files",
"(",
"self",
",",
"filters",
"=",
"None",
")",
":",
"filters",
"=",
"compile_masks",
"(",
"filters",
"or",
"[",
"r'.*'",
"]",
")",
"for",
"files",
"in",
"itervalues",
"(",
"self",
".",
"_found",
")",
":",
"for",
"file_",
"in",
"files"... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Finder.directories | A generator that produces a sequence of paths to directories in the
project that matches the specified filters.
:param filters:
the regular expressions to use when finding directories in the
project. If not specified, all directories are returned.
:type filters: list(str... | src/tidypy/finder.py | def directories(self, filters=None, containing=None):
"""
A generator that produces a sequence of paths to directories in the
project that matches the specified filters.
:param filters:
the regular expressions to use when finding directories in the
project. If no... | def directories(self, filters=None, containing=None):
"""
A generator that produces a sequence of paths to directories in the
project that matches the specified filters.
:param filters:
the regular expressions to use when finding directories in the
project. If no... | [
"A",
"generator",
"that",
"produces",
"a",
"sequence",
"of",
"paths",
"to",
"directories",
"in",
"the",
"project",
"that",
"matches",
"the",
"specified",
"filters",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/finder.py#L128-L151 | [
"def",
"directories",
"(",
"self",
",",
"filters",
"=",
"None",
",",
"containing",
"=",
"None",
")",
":",
"filters",
"=",
"compile_masks",
"(",
"filters",
"or",
"[",
"r'.*'",
"]",
")",
"contains",
"=",
"compile_masks",
"(",
"containing",
")",
"for",
"dir... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Finder.modules | A generator that produces a sequence of paths to files that look to be
Python modules (e.g., ``*.py``).
:param filters:
the regular expressions to use when finding files in the project.
If not specified, all files are returned.
:type filters: list(str) | src/tidypy/finder.py | def modules(self, filters=None):
"""
A generator that produces a sequence of paths to files that look to be
Python modules (e.g., ``*.py``).
:param filters:
the regular expressions to use when finding files in the project.
If not specified, all files are returned... | def modules(self, filters=None):
"""
A generator that produces a sequence of paths to files that look to be
Python modules (e.g., ``*.py``).
:param filters:
the regular expressions to use when finding files in the project.
If not specified, all files are returned... | [
"A",
"generator",
"that",
"produces",
"a",
"sequence",
"of",
"paths",
"to",
"files",
"that",
"look",
"to",
"be",
"Python",
"modules",
"(",
"e",
".",
"g",
".",
"*",
".",
"py",
")",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/finder.py#L169-L183 | [
"def",
"modules",
"(",
"self",
",",
"filters",
"=",
"None",
")",
":",
"masks",
"=",
"compile_masks",
"(",
"r'\\.py$'",
")",
"for",
"file_",
"in",
"self",
".",
"files",
"(",
"filters",
"=",
"filters",
")",
":",
"if",
"matches_masks",
"(",
"file_",
",",
... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Finder.sys_paths | Produces a list of paths that would be suitable to use in ``sys.path``
in order to access the Python modules/packages found in this project.
:param filters:
the regular expressions to use when finding files in the project.
If not specified, all files are returned.
:type ... | src/tidypy/finder.py | def sys_paths(self, filters=None):
"""
Produces a list of paths that would be suitable to use in ``sys.path``
in order to access the Python modules/packages found in this project.
:param filters:
the regular expressions to use when finding files in the project.
I... | def sys_paths(self, filters=None):
"""
Produces a list of paths that would be suitable to use in ``sys.path``
in order to access the Python modules/packages found in this project.
:param filters:
the regular expressions to use when finding files in the project.
I... | [
"Produces",
"a",
"list",
"of",
"paths",
"that",
"would",
"be",
"suitable",
"to",
"use",
"in",
"sys",
".",
"path",
"in",
"order",
"to",
"access",
"the",
"Python",
"modules",
"/",
"packages",
"found",
"in",
"this",
"project",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/finder.py#L185-L210 | [
"def",
"sys_paths",
"(",
"self",
",",
"filters",
"=",
"None",
")",
":",
"paths",
"=",
"set",
"(",
")",
"packages",
"=",
"list",
"(",
"self",
".",
"packages",
"(",
"filters",
"=",
"filters",
")",
")",
"for",
"module",
"in",
"self",
".",
"modules",
"... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Collector.add_issues | Adds an issue to the collection.
:param issues: the issue(s) to add
:type issues: tidypy.Issue or list(tidypy.Issue) | src/tidypy/collector.py | def add_issues(self, issues):
"""
Adds an issue to the collection.
:param issues: the issue(s) to add
:type issues: tidypy.Issue or list(tidypy.Issue)
"""
if not isinstance(issues, (list, tuple)):
issues = [issues]
with self._lock:
self._... | def add_issues(self, issues):
"""
Adds an issue to the collection.
:param issues: the issue(s) to add
:type issues: tidypy.Issue or list(tidypy.Issue)
"""
if not isinstance(issues, (list, tuple)):
issues = [issues]
with self._lock:
self._... | [
"Adds",
"an",
"issue",
"to",
"the",
"collection",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/collector.py#L46-L58 | [
"def",
"add_issues",
"(",
"self",
",",
"issues",
")",
":",
"if",
"not",
"isinstance",
"(",
"issues",
",",
"(",
"list",
",",
"tuple",
")",
")",
":",
"issues",
"=",
"[",
"issues",
"]",
"with",
"self",
".",
"_lock",
":",
"self",
".",
"_all_issues",
".... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Collector.issue_count | Returns the number of issues in the collection.
:param include_unclean:
whether or not to include issues that are being ignored due to
being a duplicate, excluded, etc.
:type include_unclean: bool
:rtype: int | src/tidypy/collector.py | def issue_count(self, include_unclean=False):
"""
Returns the number of issues in the collection.
:param include_unclean:
whether or not to include issues that are being ignored due to
being a duplicate, excluded, etc.
:type include_unclean: bool
:rtype: ... | def issue_count(self, include_unclean=False):
"""
Returns the number of issues in the collection.
:param include_unclean:
whether or not to include issues that are being ignored due to
being a duplicate, excluded, etc.
:type include_unclean: bool
:rtype: ... | [
"Returns",
"the",
"number",
"of",
"issues",
"in",
"the",
"collection",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/collector.py#L60-L74 | [
"def",
"issue_count",
"(",
"self",
",",
"include_unclean",
"=",
"False",
")",
":",
"if",
"include_unclean",
":",
"return",
"len",
"(",
"self",
".",
"_all_issues",
")",
"self",
".",
"_ensure_cleaned_issues",
"(",
")",
"return",
"len",
"(",
"self",
".",
"_cl... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Collector.get_issues | Retrieves the issues in the collection.
:param sortby: the properties to sort the issues by
:type sortby: list(str)
:rtype: list(tidypy.Issue) | src/tidypy/collector.py | def get_issues(self, sortby=None):
"""
Retrieves the issues in the collection.
:param sortby: the properties to sort the issues by
:type sortby: list(str)
:rtype: list(tidypy.Issue)
"""
self._ensure_cleaned_issues()
return self._sort_issues(self._cleaned... | def get_issues(self, sortby=None):
"""
Retrieves the issues in the collection.
:param sortby: the properties to sort the issues by
:type sortby: list(str)
:rtype: list(tidypy.Issue)
"""
self._ensure_cleaned_issues()
return self._sort_issues(self._cleaned... | [
"Retrieves",
"the",
"issues",
"in",
"the",
"collection",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/collector.py#L76-L86 | [
"def",
"get_issues",
"(",
"self",
",",
"sortby",
"=",
"None",
")",
":",
"self",
".",
"_ensure_cleaned_issues",
"(",
")",
"return",
"self",
".",
"_sort_issues",
"(",
"self",
".",
"_cleaned_issues",
",",
"sortby",
")"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Collector.get_grouped_issues | Retrieves the issues in the collection grouped into buckets according
to the key generated by the keyfunc.
:param keyfunc:
a function that will be used to generate the key that identifies
the group that an issue will be assigned to. This function receives
a single ti... | src/tidypy/collector.py | def get_grouped_issues(self, keyfunc=None, sortby=None):
"""
Retrieves the issues in the collection grouped into buckets according
to the key generated by the keyfunc.
:param keyfunc:
a function that will be used to generate the key that identifies
the group that... | def get_grouped_issues(self, keyfunc=None, sortby=None):
"""
Retrieves the issues in the collection grouped into buckets according
to the key generated by the keyfunc.
:param keyfunc:
a function that will be used to generate the key that identifies
the group that... | [
"Retrieves",
"the",
"issues",
"in",
"the",
"collection",
"grouped",
"into",
"buckets",
"according",
"to",
"the",
"key",
"generated",
"by",
"the",
"keyfunc",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/collector.py#L88-L109 | [
"def",
"get_grouped_issues",
"(",
"self",
",",
"keyfunc",
"=",
"None",
",",
"sortby",
"=",
"None",
")",
":",
"if",
"not",
"keyfunc",
":",
"keyfunc",
"=",
"default_group",
"if",
"not",
"sortby",
":",
"sortby",
"=",
"self",
".",
"DEFAULT_SORT",
"self",
"."... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Extender.parse | A convenience method for parsing a TOML-serialized configuration.
:param content: a TOML string containing a TidyPy configuration
:type content: str
:param is_pyproject:
whether or not the content is (or resembles) a ``pyproject.toml``
file, where the TidyPy configuratio... | src/tidypy/extenders/base.py | def parse(cls, content, is_pyproject=False):
"""
A convenience method for parsing a TOML-serialized configuration.
:param content: a TOML string containing a TidyPy configuration
:type content: str
:param is_pyproject:
whether or not the content is (or resembles) a `... | def parse(cls, content, is_pyproject=False):
"""
A convenience method for parsing a TOML-serialized configuration.
:param content: a TOML string containing a TidyPy configuration
:type content: str
:param is_pyproject:
whether or not the content is (or resembles) a `... | [
"A",
"convenience",
"method",
"for",
"parsing",
"a",
"TOML",
"-",
"serialized",
"configuration",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/extenders/base.py#L40-L60 | [
"def",
"parse",
"(",
"cls",
",",
"content",
",",
"is_pyproject",
"=",
"False",
")",
":",
"parsed",
"=",
"pytoml",
".",
"loads",
"(",
"content",
")",
"if",
"is_pyproject",
":",
"parsed",
"=",
"parsed",
".",
"get",
"(",
"'tool'",
",",
"{",
"}",
")",
... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | get_tools | Retrieves the TidyPy tools that are available in the current Python
environment.
The returned dictionary has keys that are the tool names and values are the
tool classes.
:rtype: dict | src/tidypy/config.py | def get_tools():
"""
Retrieves the TidyPy tools that are available in the current Python
environment.
The returned dictionary has keys that are the tool names and values are the
tool classes.
:rtype: dict
"""
# pylint: disable=protected-access
if not hasattr(get_tools, '_CACHE'):... | def get_tools():
"""
Retrieves the TidyPy tools that are available in the current Python
environment.
The returned dictionary has keys that are the tool names and values are the
tool classes.
:rtype: dict
"""
# pylint: disable=protected-access
if not hasattr(get_tools, '_CACHE'):... | [
"Retrieves",
"the",
"TidyPy",
"tools",
"that",
"are",
"available",
"in",
"the",
"current",
"Python",
"environment",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L18-L44 | [
"def",
"get_tools",
"(",
")",
":",
"# pylint: disable=protected-access",
"if",
"not",
"hasattr",
"(",
"get_tools",
",",
"'_CACHE'",
")",
":",
"get_tools",
".",
"_CACHE",
"=",
"dict",
"(",
")",
"for",
"entry",
"in",
"pkg_resources",
".",
"iter_entry_points",
"(... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | get_reports | Retrieves the TidyPy issue reports that are available in the current Python
environment.
The returned dictionary has keys are the report names and values are the
report classes.
:rtype: dict | src/tidypy/config.py | def get_reports():
"""
Retrieves the TidyPy issue reports that are available in the current Python
environment.
The returned dictionary has keys are the report names and values are the
report classes.
:rtype: dict
"""
# pylint: disable=protected-access
if not hasattr(get_reports,... | def get_reports():
"""
Retrieves the TidyPy issue reports that are available in the current Python
environment.
The returned dictionary has keys are the report names and values are the
report classes.
:rtype: dict
"""
# pylint: disable=protected-access
if not hasattr(get_reports,... | [
"Retrieves",
"the",
"TidyPy",
"issue",
"reports",
"that",
"are",
"available",
"in",
"the",
"current",
"Python",
"environment",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L47-L73 | [
"def",
"get_reports",
"(",
")",
":",
"# pylint: disable=protected-access",
"if",
"not",
"hasattr",
"(",
"get_reports",
",",
"'_CACHE'",
")",
":",
"get_reports",
".",
"_CACHE",
"=",
"dict",
"(",
")",
"for",
"entry",
"in",
"pkg_resources",
".",
"iter_entry_points"... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | get_extenders | Retrieves the TidyPy configuration extenders that are available in the
current Python environment.
The returned dictionary has keys are the extender names and values are the
extender classes.
:rtype: dict | src/tidypy/config.py | def get_extenders():
"""
Retrieves the TidyPy configuration extenders that are available in the
current Python environment.
The returned dictionary has keys are the extender names and values are the
extender classes.
:rtype: dict
"""
# pylint: disable=protected-access
if not hasa... | def get_extenders():
"""
Retrieves the TidyPy configuration extenders that are available in the
current Python environment.
The returned dictionary has keys are the extender names and values are the
extender classes.
:rtype: dict
"""
# pylint: disable=protected-access
if not hasa... | [
"Retrieves",
"the",
"TidyPy",
"configuration",
"extenders",
"that",
"are",
"available",
"in",
"the",
"current",
"Python",
"environment",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L76-L102 | [
"def",
"get_extenders",
"(",
")",
":",
"# pylint: disable=protected-access",
"if",
"not",
"hasattr",
"(",
"get_extenders",
",",
"'_CACHE'",
")",
":",
"get_extenders",
".",
"_CACHE",
"=",
"dict",
"(",
")",
"for",
"entry",
"in",
"pkg_resources",
".",
"iter_entry_p... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | purge_config_cache | Clears out the cache of TidyPy configurations that were retrieved from
outside the normal locations. | src/tidypy/config.py | def purge_config_cache(location=None):
"""
Clears out the cache of TidyPy configurations that were retrieved from
outside the normal locations.
"""
cache_path = get_cache_path(location)
if location:
os.remove(cache_path)
else:
shutil.rmtree(cache_path) | def purge_config_cache(location=None):
"""
Clears out the cache of TidyPy configurations that were retrieved from
outside the normal locations.
"""
cache_path = get_cache_path(location)
if location:
os.remove(cache_path)
else:
shutil.rmtree(cache_path) | [
"Clears",
"out",
"the",
"cache",
"of",
"TidyPy",
"configurations",
"that",
"were",
"retrieved",
"from",
"outside",
"the",
"normal",
"locations",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L124-L135 | [
"def",
"purge_config_cache",
"(",
"location",
"=",
"None",
")",
":",
"cache_path",
"=",
"get_cache_path",
"(",
"location",
")",
"if",
"location",
":",
"os",
".",
"remove",
"(",
"cache_path",
")",
"else",
":",
"shutil",
".",
"rmtree",
"(",
"cache_path",
")"... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | get_default_config | Produces a stock/out-of-the-box TidyPy configuration.
:rtype: dict | src/tidypy/config.py | def get_default_config():
"""
Produces a stock/out-of-the-box TidyPy configuration.
:rtype: dict
"""
config = {}
for name, cls in iteritems(get_tools()):
config[name] = cls.get_default_config()
try:
workers = multiprocessing.cpu_count() - 1
except NotImplementedError:... | def get_default_config():
"""
Produces a stock/out-of-the-box TidyPy configuration.
:rtype: dict
"""
config = {}
for name, cls in iteritems(get_tools()):
config[name] = cls.get_default_config()
try:
workers = multiprocessing.cpu_count() - 1
except NotImplementedError:... | [
"Produces",
"a",
"stock",
"/",
"out",
"-",
"of",
"-",
"the",
"-",
"box",
"TidyPy",
"configuration",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L201-L234 | [
"def",
"get_default_config",
"(",
")",
":",
"config",
"=",
"{",
"}",
"for",
"name",
",",
"cls",
"in",
"iteritems",
"(",
"get_tools",
"(",
")",
")",
":",
"config",
"[",
"name",
"]",
"=",
"cls",
".",
"get_default_config",
"(",
")",
"try",
":",
"workers... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | get_user_config | Produces a TidyPy configuration that incorporates the configuration files
stored in the current user's home directory.
:param project_path: the path to the project that is going to be analyzed
:type project_path: str
:param use_cache:
whether or not to use cached versions of any remote/referenc... | src/tidypy/config.py | def get_user_config(project_path, use_cache=True):
"""
Produces a TidyPy configuration that incorporates the configuration files
stored in the current user's home directory.
:param project_path: the path to the project that is going to be analyzed
:type project_path: str
:param use_cache:
... | def get_user_config(project_path, use_cache=True):
"""
Produces a TidyPy configuration that incorporates the configuration files
stored in the current user's home directory.
:param project_path: the path to the project that is going to be analyzed
:type project_path: str
:param use_cache:
... | [
"Produces",
"a",
"TidyPy",
"configuration",
"that",
"incorporates",
"the",
"configuration",
"files",
"stored",
"in",
"the",
"current",
"user",
"s",
"home",
"directory",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L237-L267 | [
"def",
"get_user_config",
"(",
"project_path",
",",
"use_cache",
"=",
"True",
")",
":",
"if",
"sys",
".",
"platform",
"==",
"'win32'",
":",
"user_config",
"=",
"os",
".",
"path",
".",
"expanduser",
"(",
"r'~\\\\tidypy'",
")",
"else",
":",
"user_config",
"=... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | get_local_config | Produces a TidyPy configuration using the ``pyproject.toml`` in the
project's directory.
:param project_path: the path to the project that is going to be analyzed
:type project_path: str
:param use_cache:
whether or not to use cached versions of any remote/referenced TidyPy
configuratio... | src/tidypy/config.py | def get_local_config(project_path, use_cache=True):
"""
Produces a TidyPy configuration using the ``pyproject.toml`` in the
project's directory.
:param project_path: the path to the project that is going to be analyzed
:type project_path: str
:param use_cache:
whether or not to use cach... | def get_local_config(project_path, use_cache=True):
"""
Produces a TidyPy configuration using the ``pyproject.toml`` in the
project's directory.
:param project_path: the path to the project that is going to be analyzed
:type project_path: str
:param use_cache:
whether or not to use cach... | [
"Produces",
"a",
"TidyPy",
"configuration",
"using",
"the",
"pyproject",
".",
"toml",
"in",
"the",
"project",
"s",
"directory",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L270-L295 | [
"def",
"get_local_config",
"(",
"project_path",
",",
"use_cache",
"=",
"True",
")",
":",
"pyproject_path",
"=",
"os",
".",
"path",
".",
"join",
"(",
"project_path",
",",
"'pyproject.toml'",
")",
"if",
"os",
".",
"path",
".",
"exists",
"(",
"pyproject_path",
... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | get_project_config | Produces the Tidypy configuration to use for the specified project.
If a ``pyproject.toml`` exists, the configuration will be based on that. If
not, the TidyPy configuration in the user's home directory will be used. If
one does not exist, the default configuration will be used.
:param project_path: t... | src/tidypy/config.py | def get_project_config(project_path, use_cache=True):
"""
Produces the Tidypy configuration to use for the specified project.
If a ``pyproject.toml`` exists, the configuration will be based on that. If
not, the TidyPy configuration in the user's home directory will be used. If
one does not exist, t... | def get_project_config(project_path, use_cache=True):
"""
Produces the Tidypy configuration to use for the specified project.
If a ``pyproject.toml`` exists, the configuration will be based on that. If
not, the TidyPy configuration in the user's home directory will be used. If
one does not exist, t... | [
"Produces",
"the",
"Tidypy",
"configuration",
"to",
"use",
"for",
"the",
"specified",
"project",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/config.py#L298-L317 | [
"def",
"get_project_config",
"(",
"project_path",
",",
"use_cache",
"=",
"True",
")",
":",
"return",
"get_local_config",
"(",
"project_path",
",",
"use_cache",
"=",
"use_cache",
")",
"or",
"get_user_config",
"(",
"project_path",
",",
"use_cache",
"=",
"use_cache",... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | merge_list | Merges the contents of two lists into a new list.
:param list1: the first list
:type list1: list
:param list2: the second list
:type list2: list
:returns: list | src/tidypy/util.py | def merge_list(list1, list2):
"""
Merges the contents of two lists into a new list.
:param list1: the first list
:type list1: list
:param list2: the second list
:type list2: list
:returns: list
"""
merged = list(list1)
for value in list2:
if value not in merged:
... | def merge_list(list1, list2):
"""
Merges the contents of two lists into a new list.
:param list1: the first list
:type list1: list
:param list2: the second list
:type list2: list
:returns: list
"""
merged = list(list1)
for value in list2:
if value not in merged:
... | [
"Merges",
"the",
"contents",
"of",
"two",
"lists",
"into",
"a",
"new",
"list",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L23-L40 | [
"def",
"merge_list",
"(",
"list1",
",",
"list2",
")",
":",
"merged",
"=",
"list",
"(",
"list1",
")",
"for",
"value",
"in",
"list2",
":",
"if",
"value",
"not",
"in",
"merged",
":",
"merged",
".",
"append",
"(",
"value",
")",
"return",
"merged"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | merge_dict | Recursively merges the contents of two dictionaries into a new dictionary.
When both input dictionaries share a key, the value from ``dict2`` is
kept.
:param dict1: the first dictionary
:type dict1: dict
:param dict2: the second dictionary
:type dict2: dict
:param merge_lists:
when... | src/tidypy/util.py | def merge_dict(dict1, dict2, merge_lists=False):
"""
Recursively merges the contents of two dictionaries into a new dictionary.
When both input dictionaries share a key, the value from ``dict2`` is
kept.
:param dict1: the first dictionary
:type dict1: dict
:param dict2: the second dictiona... | def merge_dict(dict1, dict2, merge_lists=False):
"""
Recursively merges the contents of two dictionaries into a new dictionary.
When both input dictionaries share a key, the value from ``dict2`` is
kept.
:param dict1: the first dictionary
:type dict1: dict
:param dict2: the second dictiona... | [
"Recursively",
"merges",
"the",
"contents",
"of",
"two",
"dictionaries",
"into",
"a",
"new",
"dictionary",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L43-L72 | [
"def",
"merge_dict",
"(",
"dict1",
",",
"dict2",
",",
"merge_lists",
"=",
"False",
")",
":",
"merged",
"=",
"dict",
"(",
"dict1",
")",
"for",
"key",
",",
"value",
"in",
"iteritems",
"(",
"dict2",
")",
":",
"if",
"isinstance",
"(",
"merged",
".",
"get... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | output_error | Prints the specified string to ``stderr``.
:param msg: the message to print
:type msg: str | src/tidypy/util.py | def output_error(msg):
"""
Prints the specified string to ``stderr``.
:param msg: the message to print
:type msg: str
"""
click.echo(click.style(msg, fg='red'), err=True) | def output_error(msg):
"""
Prints the specified string to ``stderr``.
:param msg: the message to print
:type msg: str
"""
click.echo(click.style(msg, fg='red'), err=True) | [
"Prints",
"the",
"specified",
"string",
"to",
"stderr",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L75-L83 | [
"def",
"output_error",
"(",
"msg",
")",
":",
"click",
".",
"echo",
"(",
"click",
".",
"style",
"(",
"msg",
",",
"fg",
"=",
"'red'",
")",
",",
"err",
"=",
"True",
")"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | mod_sys_path | A context manager that will append the specified paths to Python's
``sys.path`` during the execution of the block.
:param paths: the paths to append
:type paths: list(str) | src/tidypy/util.py | def mod_sys_path(paths):
"""
A context manager that will append the specified paths to Python's
``sys.path`` during the execution of the block.
:param paths: the paths to append
:type paths: list(str)
"""
old_path = sys.path
sys.path = paths + sys.path
try:
yield
finall... | def mod_sys_path(paths):
"""
A context manager that will append the specified paths to Python's
``sys.path`` during the execution of the block.
:param paths: the paths to append
:type paths: list(str)
"""
old_path = sys.path
sys.path = paths + sys.path
try:
yield
finall... | [
"A",
"context",
"manager",
"that",
"will",
"append",
"the",
"specified",
"paths",
"to",
"Python",
"s",
"sys",
".",
"path",
"during",
"the",
"execution",
"of",
"the",
"block",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L87-L101 | [
"def",
"mod_sys_path",
"(",
"paths",
")",
":",
"old_path",
"=",
"sys",
".",
"path",
"sys",
".",
"path",
"=",
"paths",
"+",
"sys",
".",
"path",
"try",
":",
"yield",
"finally",
":",
"sys",
".",
"path",
"=",
"old_path"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | compile_masks | Compiles a list of regular expressions.
:param masks: the regular expressions to compile
:type masks: list(str) or str
:returns: list(regular expression object) | src/tidypy/util.py | def compile_masks(masks):
"""
Compiles a list of regular expressions.
:param masks: the regular expressions to compile
:type masks: list(str) or str
:returns: list(regular expression object)
"""
if not masks:
masks = []
elif not isinstance(masks, (list, tuple)):
masks =... | def compile_masks(masks):
"""
Compiles a list of regular expressions.
:param masks: the regular expressions to compile
:type masks: list(str) or str
:returns: list(regular expression object)
"""
if not masks:
masks = []
elif not isinstance(masks, (list, tuple)):
masks =... | [
"Compiles",
"a",
"list",
"of",
"regular",
"expressions",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L145-L162 | [
"def",
"compile_masks",
"(",
"masks",
")",
":",
"if",
"not",
"masks",
":",
"masks",
"=",
"[",
"]",
"elif",
"not",
"isinstance",
"(",
"masks",
",",
"(",
"list",
",",
"tuple",
")",
")",
":",
"masks",
"=",
"[",
"masks",
"]",
"return",
"[",
"re",
"."... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | matches_masks | Determines whether or not the target string matches any of the regular
expressions specified.
:param target: the string to check
:type target: str
:param masks: the regular expressions to check against
:type masks: list(regular expression object)
:returns: bool | src/tidypy/util.py | def matches_masks(target, masks):
"""
Determines whether or not the target string matches any of the regular
expressions specified.
:param target: the string to check
:type target: str
:param masks: the regular expressions to check against
:type masks: list(regular expression object)
:r... | def matches_masks(target, masks):
"""
Determines whether or not the target string matches any of the regular
expressions specified.
:param target: the string to check
:type target: str
:param masks: the regular expressions to check against
:type masks: list(regular expression object)
:r... | [
"Determines",
"whether",
"or",
"not",
"the",
"target",
"string",
"matches",
"any",
"of",
"the",
"regular",
"expressions",
"specified",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L165-L180 | [
"def",
"matches_masks",
"(",
"target",
",",
"masks",
")",
":",
"for",
"mask",
"in",
"masks",
":",
"if",
"mask",
".",
"search",
"(",
"target",
")",
":",
"return",
"True",
"return",
"False"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | read_file | Retrieves the contents of the specified file.
This function performs simple caching so that the same file isn't read more
than once per process.
:param filepath: the file to read
:type filepath: str
:returns: str | src/tidypy/util.py | def read_file(filepath):
"""
Retrieves the contents of the specified file.
This function performs simple caching so that the same file isn't read more
than once per process.
:param filepath: the file to read
:type filepath: str
:returns: str
"""
with _FILE_CACHE_LOCK:
if f... | def read_file(filepath):
"""
Retrieves the contents of the specified file.
This function performs simple caching so that the same file isn't read more
than once per process.
:param filepath: the file to read
:type filepath: str
:returns: str
"""
with _FILE_CACHE_LOCK:
if f... | [
"Retrieves",
"the",
"contents",
"of",
"the",
"specified",
"file",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L221-L236 | [
"def",
"read_file",
"(",
"filepath",
")",
":",
"with",
"_FILE_CACHE_LOCK",
":",
"if",
"filepath",
"not",
"in",
"_FILE_CACHE",
":",
"_FILE_CACHE",
"[",
"filepath",
"]",
"=",
"_read_file",
"(",
"filepath",
")",
"return",
"_FILE_CACHE",
"[",
"filepath",
"]"
] | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | parse_python_file | Retrieves the AST of the specified file.
This function performs simple caching so that the same file isn't read or
parsed more than once per process.
:param filepath: the file to parse
:type filepath: str
:returns: ast.AST | src/tidypy/util.py | def parse_python_file(filepath):
"""
Retrieves the AST of the specified file.
This function performs simple caching so that the same file isn't read or
parsed more than once per process.
:param filepath: the file to parse
:type filepath: str
:returns: ast.AST
"""
with _AST_CACHE_L... | def parse_python_file(filepath):
"""
Retrieves the AST of the specified file.
This function performs simple caching so that the same file isn't read or
parsed more than once per process.
:param filepath: the file to parse
:type filepath: str
:returns: ast.AST
"""
with _AST_CACHE_L... | [
"Retrieves",
"the",
"AST",
"of",
"the",
"specified",
"file",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/util.py#L243-L259 | [
"def",
"parse_python_file",
"(",
"filepath",
")",
":",
"with",
"_AST_CACHE_LOCK",
":",
"if",
"filepath",
"not",
"in",
"_AST_CACHE",
":",
"source",
"=",
"read_file",
"(",
"filepath",
")",
"_AST_CACHE",
"[",
"filepath",
"]",
"=",
"ast",
".",
"parse",
"(",
"s... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Progress.on_tool_finish | Called when an individual tool completes execution.
:param tool: the name of the tool that completed
:type tool: str | src/tidypy/progress.py | def on_tool_finish(self, tool):
"""
Called when an individual tool completes execution.
:param tool: the name of the tool that completed
:type tool: str
"""
with self._lock:
if tool in self.current_tools:
self.current_tools.remove(tool)
... | def on_tool_finish(self, tool):
"""
Called when an individual tool completes execution.
:param tool: the name of the tool that completed
:type tool: str
"""
with self._lock:
if tool in self.current_tools:
self.current_tools.remove(tool)
... | [
"Called",
"when",
"an",
"individual",
"tool",
"completes",
"execution",
"."
] | jayclassless/tidypy | python | https://github.com/jayclassless/tidypy/blob/3c3497ca377fbbe937103b77b02b326c860c748f/src/tidypy/progress.py#L41-L52 | [
"def",
"on_tool_finish",
"(",
"self",
",",
"tool",
")",
":",
"with",
"self",
".",
"_lock",
":",
"if",
"tool",
"in",
"self",
".",
"current_tools",
":",
"self",
".",
"current_tools",
".",
"remove",
"(",
"tool",
")",
"self",
".",
"completed_tools",
".",
"... | 3c3497ca377fbbe937103b77b02b326c860c748f |
valid | Emulator.exec_command | Execute an x3270 command
`cmdstr` gets sent directly to the x3270 subprocess on it's stdin. | py3270/__init__.py | def exec_command(self, cmdstr):
"""
Execute an x3270 command
`cmdstr` gets sent directly to the x3270 subprocess on it's stdin.
"""
if self.is_terminated:
raise TerminatedError("this TerminalClient instance has been terminated")
log.debug("sending co... | def exec_command(self, cmdstr):
"""
Execute an x3270 command
`cmdstr` gets sent directly to the x3270 subprocess on it's stdin.
"""
if self.is_terminated:
raise TerminatedError("this TerminalClient instance has been terminated")
log.debug("sending co... | [
"Execute",
"an",
"x3270",
"command"
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L296-L313 | [
"def",
"exec_command",
"(",
"self",
",",
"cmdstr",
")",
":",
"if",
"self",
".",
"is_terminated",
":",
"raise",
"TerminatedError",
"(",
"\"this TerminalClient instance has been terminated\"",
")",
"log",
".",
"debug",
"(",
"\"sending command: %s\"",
",",
"cmdstr",
")... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.terminate | terminates the underlying x3270 subprocess. Once called, this
Emulator instance must no longer be used. | py3270/__init__.py | def terminate(self):
"""
terminates the underlying x3270 subprocess. Once called, this
Emulator instance must no longer be used.
"""
if not self.is_terminated:
log.debug("terminal client terminated")
try:
self.exec_command(b"Quit")
... | def terminate(self):
"""
terminates the underlying x3270 subprocess. Once called, this
Emulator instance must no longer be used.
"""
if not self.is_terminated:
log.debug("terminal client terminated")
try:
self.exec_command(b"Quit")
... | [
"terminates",
"the",
"underlying",
"x3270",
"subprocess",
".",
"Once",
"called",
"this",
"Emulator",
"instance",
"must",
"no",
"longer",
"be",
"used",
"."
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L315-L335 | [
"def",
"terminate",
"(",
"self",
")",
":",
"if",
"not",
"self",
".",
"is_terminated",
":",
"log",
".",
"debug",
"(",
"\"terminal client terminated\"",
")",
"try",
":",
"self",
".",
"exec_command",
"(",
"b\"Quit\"",
")",
"except",
"BrokenPipeError",
":",
"# n... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.is_connected | Return bool indicating connection state | py3270/__init__.py | def is_connected(self):
"""
Return bool indicating connection state
"""
# need to wrap in try/except b/c of wc3270's socket connection dynamics
try:
# this is basically a no-op, but it results in the the current status
# getting updated
sel... | def is_connected(self):
"""
Return bool indicating connection state
"""
# need to wrap in try/except b/c of wc3270's socket connection dynamics
try:
# this is basically a no-op, but it results in the the current status
# getting updated
sel... | [
"Return",
"bool",
"indicating",
"connection",
"state"
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L337-L350 | [
"def",
"is_connected",
"(",
"self",
")",
":",
"# need to wrap in try/except b/c of wc3270's socket connection dynamics",
"try",
":",
"# this is basically a no-op, but it results in the the current status",
"# getting updated",
"self",
".",
"exec_command",
"(",
"b\"Query(ConnectionState... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.connect | Connect to a host | py3270/__init__.py | def connect(self, host):
"""
Connect to a host
"""
if not self.app.connect(host):
command = "Connect({0})".format(host).encode("ascii")
self.exec_command(command)
self.last_host = host | def connect(self, host):
"""
Connect to a host
"""
if not self.app.connect(host):
command = "Connect({0})".format(host).encode("ascii")
self.exec_command(command)
self.last_host = host | [
"Connect",
"to",
"a",
"host"
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L352-L359 | [
"def",
"connect",
"(",
"self",
",",
"host",
")",
":",
"if",
"not",
"self",
".",
"app",
".",
"connect",
"(",
"host",
")",
":",
"command",
"=",
"\"Connect({0})\"",
".",
"format",
"(",
"host",
")",
".",
"encode",
"(",
"\"ascii\"",
")",
"self",
".",
"e... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.wait_for_field | Wait until the screen is ready, the cursor has been positioned
on a modifiable field, and the keyboard is unlocked.
Sometimes the server will "unlock" the keyboard but the screen will
not yet be ready. In that case, an attempt to read or write to the
screen will result ... | py3270/__init__.py | def wait_for_field(self):
"""
Wait until the screen is ready, the cursor has been positioned
on a modifiable field, and the keyboard is unlocked.
Sometimes the server will "unlock" the keyboard but the screen will
not yet be ready. In that case, an attempt to re... | def wait_for_field(self):
"""
Wait until the screen is ready, the cursor has been positioned
on a modifiable field, and the keyboard is unlocked.
Sometimes the server will "unlock" the keyboard but the screen will
not yet be ready. In that case, an attempt to re... | [
"Wait",
"until",
"the",
"screen",
"is",
"ready",
"the",
"cursor",
"has",
"been",
"positioned",
"on",
"a",
"modifiable",
"field",
"and",
"the",
"keyboard",
"is",
"unlocked",
"."
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L368-L387 | [
"def",
"wait_for_field",
"(",
"self",
")",
":",
"self",
".",
"exec_command",
"(",
"\"Wait({0}, InputField)\"",
".",
"format",
"(",
"self",
".",
"timeout",
")",
".",
"encode",
"(",
"\"ascii\"",
")",
")",
"if",
"self",
".",
"status",
".",
"keyboard",
"!=",
... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.move_to | move the cursor to the given co-ordinates. Co-ordinates are 1
based, as listed in the status area of the terminal. | py3270/__init__.py | def move_to(self, ypos, xpos):
"""
move the cursor to the given co-ordinates. Co-ordinates are 1
based, as listed in the status area of the terminal.
"""
# the screen's co-ordinates are 1 based, but the command is 0 based
xpos -= 1
ypos -= 1
self.... | def move_to(self, ypos, xpos):
"""
move the cursor to the given co-ordinates. Co-ordinates are 1
based, as listed in the status area of the terminal.
"""
# the screen's co-ordinates are 1 based, but the command is 0 based
xpos -= 1
ypos -= 1
self.... | [
"move",
"the",
"cursor",
"to",
"the",
"given",
"co",
"-",
"ordinates",
".",
"Co",
"-",
"ordinates",
"are",
"1",
"based",
"as",
"listed",
"in",
"the",
"status",
"area",
"of",
"the",
"terminal",
"."
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L389-L397 | [
"def",
"move_to",
"(",
"self",
",",
"ypos",
",",
"xpos",
")",
":",
"# the screen's co-ordinates are 1 based, but the command is 0 based",
"xpos",
"-=",
"1",
"ypos",
"-=",
"1",
"self",
".",
"exec_command",
"(",
"\"MoveCursor({0}, {1})\"",
".",
"format",
"(",
"ypos",
... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.send_string | Send a string to the screen at the current cursor location or at
screen co-ordinates `ypos`/`xpos` if they are both given.
Co-ordinates are 1 based, as listed in the status area of the
terminal. | py3270/__init__.py | def send_string(self, tosend, ypos=None, xpos=None):
"""
Send a string to the screen at the current cursor location or at
screen co-ordinates `ypos`/`xpos` if they are both given.
Co-ordinates are 1 based, as listed in the status area of the
terminal.
"""... | def send_string(self, tosend, ypos=None, xpos=None):
"""
Send a string to the screen at the current cursor location or at
screen co-ordinates `ypos`/`xpos` if they are both given.
Co-ordinates are 1 based, as listed in the status area of the
terminal.
"""... | [
"Send",
"a",
"string",
"to",
"the",
"screen",
"at",
"the",
"current",
"cursor",
"location",
"or",
"at",
"screen",
"co",
"-",
"ordinates",
"ypos",
"/",
"xpos",
"if",
"they",
"are",
"both",
"given",
"."
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L399-L413 | [
"def",
"send_string",
"(",
"self",
",",
"tosend",
",",
"ypos",
"=",
"None",
",",
"xpos",
"=",
"None",
")",
":",
"if",
"xpos",
"is",
"not",
"None",
"and",
"ypos",
"is",
"not",
"None",
":",
"self",
".",
"move_to",
"(",
"ypos",
",",
"xpos",
")",
"# ... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.string_get | Get a string of `length` at screen co-ordinates `ypos`/`xpos`
Co-ordinates are 1 based, as listed in the status area of the
terminal. | py3270/__init__.py | def string_get(self, ypos, xpos, length):
"""
Get a string of `length` at screen co-ordinates `ypos`/`xpos`
Co-ordinates are 1 based, as listed in the status area of the
terminal.
"""
# the screen's co-ordinates are 1 based, but the command is 0 based
... | def string_get(self, ypos, xpos, length):
"""
Get a string of `length` at screen co-ordinates `ypos`/`xpos`
Co-ordinates are 1 based, as listed in the status area of the
terminal.
"""
# the screen's co-ordinates are 1 based, but the command is 0 based
... | [
"Get",
"a",
"string",
"of",
"length",
"at",
"screen",
"co",
"-",
"ordinates",
"ypos",
"/",
"xpos"
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L440-L455 | [
"def",
"string_get",
"(",
"self",
",",
"ypos",
",",
"xpos",
",",
"length",
")",
":",
"# the screen's co-ordinates are 1 based, but the command is 0 based",
"xpos",
"-=",
"1",
"ypos",
"-=",
"1",
"cmd",
"=",
"self",
".",
"exec_command",
"(",
"\"Ascii({0},{1},{2})\"",
... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.string_found | Return True if `string` is found at screen co-ordinates
`ypos`/`xpos`, False otherwise.
Co-ordinates are 1 based, as listed in the status area of the
terminal. | py3270/__init__.py | def string_found(self, ypos, xpos, string):
"""
Return True if `string` is found at screen co-ordinates
`ypos`/`xpos`, False otherwise.
Co-ordinates are 1 based, as listed in the status area of the
terminal.
"""
found = self.string_get(ypos, xpos,... | def string_found(self, ypos, xpos, string):
"""
Return True if `string` is found at screen co-ordinates
`ypos`/`xpos`, False otherwise.
Co-ordinates are 1 based, as listed in the status area of the
terminal.
"""
found = self.string_get(ypos, xpos,... | [
"Return",
"True",
"if",
"string",
"is",
"found",
"at",
"screen",
"co",
"-",
"ordinates",
"ypos",
"/",
"xpos",
"False",
"otherwise",
"."
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L457-L467 | [
"def",
"string_found",
"(",
"self",
",",
"ypos",
",",
"xpos",
",",
"string",
")",
":",
"found",
"=",
"self",
".",
"string_get",
"(",
"ypos",
",",
"xpos",
",",
"len",
"(",
"string",
")",
")",
"log",
".",
"debug",
"(",
"'string_found() saw \"{0}\"'",
"."... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Emulator.fill_field | clears the field at the position given and inserts the string
`tosend`
tosend: the string to insert
length: the length of the field
Co-ordinates are 1 based, as listed in the status area of the
terminal.
raises: FieldTruncateError if `tosend` is... | py3270/__init__.py | def fill_field(self, ypos, xpos, tosend, length):
"""
clears the field at the position given and inserts the string
`tosend`
tosend: the string to insert
length: the length of the field
Co-ordinates are 1 based, as listed in the status area of the
... | def fill_field(self, ypos, xpos, tosend, length):
"""
clears the field at the position given and inserts the string
`tosend`
tosend: the string to insert
length: the length of the field
Co-ordinates are 1 based, as listed in the status area of the
... | [
"clears",
"the",
"field",
"at",
"the",
"position",
"given",
"and",
"inserts",
"the",
"string",
"tosend"
] | py3270/py3270 | python | https://github.com/py3270/py3270/blob/c3e91b519f3a18b4be4799a00a96341957a8831f/py3270/__init__.py#L476-L495 | [
"def",
"fill_field",
"(",
"self",
",",
"ypos",
",",
"xpos",
",",
"tosend",
",",
"length",
")",
":",
"if",
"length",
"<",
"len",
"(",
"tosend",
")",
":",
"raise",
"FieldTruncateError",
"(",
"'length limit %d, but got \"%s\"'",
"%",
"(",
"length",
",",
"tose... | c3e91b519f3a18b4be4799a00a96341957a8831f |
valid | Adafruit_CCS811.setEnvironmentalData | Humidity is stored as an unsigned 16 bits in 1/512%RH. The
default value is 50% = 0x64, 0x00. As an example 48.5%
humidity would be 0x61, 0x00. | Adafruit_CCS811/Adafruit_CCS811.py | def setEnvironmentalData(self, humidity, temperature):
''' Humidity is stored as an unsigned 16 bits in 1/512%RH. The
default value is 50% = 0x64, 0x00. As an example 48.5%
humidity would be 0x61, 0x00.'''
''' Temperature is stored as an unsigned 16 bits integer in 1/512
degrees there is an offset: 0 maps... | def setEnvironmentalData(self, humidity, temperature):
''' Humidity is stored as an unsigned 16 bits in 1/512%RH. The
default value is 50% = 0x64, 0x00. As an example 48.5%
humidity would be 0x61, 0x00.'''
''' Temperature is stored as an unsigned 16 bits integer in 1/512
degrees there is an offset: 0 maps... | [
"Humidity",
"is",
"stored",
"as",
"an",
"unsigned",
"16",
"bits",
"in",
"1",
"/",
"512%RH",
".",
"The",
"default",
"value",
"is",
"50%",
"=",
"0x64",
"0x00",
".",
"As",
"an",
"example",
"48",
".",
"5%",
"humidity",
"would",
"be",
"0x61",
"0x00",
"."
... | adafruit/Adafruit_CCS811_python | python | https://github.com/adafruit/Adafruit_CCS811_python/blob/b75196d2f887247a316a631b81c4a909da395f3d/Adafruit_CCS811/Adafruit_CCS811.py#L147-L174 | [
"def",
"setEnvironmentalData",
"(",
"self",
",",
"humidity",
",",
"temperature",
")",
":",
"''' Temperature is stored as an unsigned 16 bits integer in 1/512\n\t\tdegrees there is an offset: 0 maps to -25C. The default value is\n\t\t25C = 0x64, 0x00. As an example 23.5% temperature would be\n\t\... | b75196d2f887247a316a631b81c4a909da395f3d |
valid | Constraint.from_func | Construct a constraint from a validation function.
Args:
func (function):
Function that evaluates True when the variables satisfy the constraint.
variables (iterable):
Iterable of variable labels.
vartype (:class:`~dimod.Vartype`/str/set):
... | dwavebinarycsp/core/constraint.py | def from_func(cls, func, variables, vartype, name=None):
"""Construct a constraint from a validation function.
Args:
func (function):
Function that evaluates True when the variables satisfy the constraint.
variables (iterable):
Iterable of variab... | def from_func(cls, func, variables, vartype, name=None):
"""Construct a constraint from a validation function.
Args:
func (function):
Function that evaluates True when the variables satisfy the constraint.
variables (iterable):
Iterable of variab... | [
"Construct",
"a",
"constraint",
"from",
"a",
"validation",
"function",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/constraint.py#L133-L188 | [
"def",
"from_func",
"(",
"cls",
",",
"func",
",",
"variables",
",",
"vartype",
",",
"name",
"=",
"None",
")",
":",
"variables",
"=",
"tuple",
"(",
"variables",
")",
"configurations",
"=",
"frozenset",
"(",
"config",
"for",
"config",
"in",
"itertools",
".... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | Constraint.from_configurations | Construct a constraint from valid configurations.
Args:
configurations (iterable[tuple]):
Valid configurations of the variables. Each configuration is a tuple of variable
assignments ordered by :attr:`~Constraint.variables`.
variables (iterable):
... | dwavebinarycsp/core/constraint.py | def from_configurations(cls, configurations, variables, vartype, name=None):
"""Construct a constraint from valid configurations.
Args:
configurations (iterable[tuple]):
Valid configurations of the variables. Each configuration is a tuple of variable
assignme... | def from_configurations(cls, configurations, variables, vartype, name=None):
"""Construct a constraint from valid configurations.
Args:
configurations (iterable[tuple]):
Valid configurations of the variables. Each configuration is a tuple of variable
assignme... | [
"Construct",
"a",
"constraint",
"from",
"valid",
"configurations",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/constraint.py#L191-L239 | [
"def",
"from_configurations",
"(",
"cls",
",",
"configurations",
",",
"variables",
",",
"vartype",
",",
"name",
"=",
"None",
")",
":",
"def",
"func",
"(",
"*",
"args",
")",
":",
"return",
"args",
"in",
"configurations",
"return",
"cls",
"(",
"func",
",",... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | Constraint.check | Check that a solution satisfies the constraint.
Args:
solution (container):
An assignment for the variables in the constraint.
Returns:
bool: True if the solution satisfies the constraint; otherwise False.
Examples:
This example creates a co... | dwavebinarycsp/core/constraint.py | def check(self, solution):
"""Check that a solution satisfies the constraint.
Args:
solution (container):
An assignment for the variables in the constraint.
Returns:
bool: True if the solution satisfies the constraint; otherwise False.
Examples:... | def check(self, solution):
"""Check that a solution satisfies the constraint.
Args:
solution (container):
An assignment for the variables in the constraint.
Returns:
bool: True if the solution satisfies the constraint; otherwise False.
Examples:... | [
"Check",
"that",
"a",
"solution",
"satisfies",
"the",
"constraint",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/constraint.py#L330-L356 | [
"def",
"check",
"(",
"self",
",",
"solution",
")",
":",
"return",
"self",
".",
"func",
"(",
"*",
"(",
"solution",
"[",
"v",
"]",
"for",
"v",
"in",
"self",
".",
"variables",
")",
")"
] | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | Constraint.fix_variable | Fix the value of a variable and remove it from the constraint.
Args:
v (variable):
Variable in the constraint to be set to a constant value.
val (int):
Value assigned to the variable. Values must match the :class:`.Vartype` of the
constra... | dwavebinarycsp/core/constraint.py | def fix_variable(self, v, value):
"""Fix the value of a variable and remove it from the constraint.
Args:
v (variable):
Variable in the constraint to be set to a constant value.
val (int):
Value assigned to the variable. Values must match the :cl... | def fix_variable(self, v, value):
"""Fix the value of a variable and remove it from the constraint.
Args:
v (variable):
Variable in the constraint to be set to a constant value.
val (int):
Value assigned to the variable. Values must match the :cl... | [
"Fix",
"the",
"value",
"of",
"a",
"variable",
"and",
"remove",
"it",
"from",
"the",
"constraint",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/constraint.py#L362-L411 | [
"def",
"fix_variable",
"(",
"self",
",",
"v",
",",
"value",
")",
":",
"variables",
"=",
"self",
".",
"variables",
"try",
":",
"idx",
"=",
"variables",
".",
"index",
"(",
"v",
")",
"except",
"ValueError",
":",
"raise",
"ValueError",
"(",
"\"given variable... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | Constraint.flip_variable | Flip a variable in the constraint.
Args:
v (variable):
Variable in the constraint to take the complementary value of its
construction value.
Examples:
This example creates a constraint that :math:`a = b` on binary variables
and flips ... | dwavebinarycsp/core/constraint.py | def flip_variable(self, v):
"""Flip a variable in the constraint.
Args:
v (variable):
Variable in the constraint to take the complementary value of its
construction value.
Examples:
This example creates a constraint that :math:`a = b` on ... | def flip_variable(self, v):
"""Flip a variable in the constraint.
Args:
v (variable):
Variable in the constraint to take the complementary value of its
construction value.
Examples:
This example creates a constraint that :math:`a = b` on ... | [
"Flip",
"a",
"variable",
"in",
"the",
"constraint",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/constraint.py#L413-L470 | [
"def",
"flip_variable",
"(",
"self",
",",
"v",
")",
":",
"try",
":",
"idx",
"=",
"self",
".",
"variables",
".",
"index",
"(",
"v",
")",
"except",
"ValueError",
":",
"raise",
"ValueError",
"(",
"\"variable {} is not a variable in constraint {}\"",
".",
"format"... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | Constraint.copy | Create a copy.
Examples:
This example copies constraint :math:`a \\ne b` and tests a solution
on the copied constraint.
>>> import dwavebinarycsp
>>> import operator
>>> const = dwavebinarycsp.Constraint.from_func(operator.ne,
... ... | dwavebinarycsp/core/constraint.py | def copy(self):
"""Create a copy.
Examples:
This example copies constraint :math:`a \\ne b` and tests a solution
on the copied constraint.
>>> import dwavebinarycsp
>>> import operator
>>> const = dwavebinarycsp.Constraint.from_func(operator.... | def copy(self):
"""Create a copy.
Examples:
This example copies constraint :math:`a \\ne b` and tests a solution
on the copied constraint.
>>> import dwavebinarycsp
>>> import operator
>>> const = dwavebinarycsp.Constraint.from_func(operator.... | [
"Create",
"a",
"copy",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/constraint.py#L476-L495 | [
"def",
"copy",
"(",
"self",
")",
":",
"# each object is itself immutable (except the function)",
"return",
"self",
".",
"__class__",
"(",
"self",
".",
"func",
",",
"self",
".",
"configurations",
",",
"self",
".",
"variables",
",",
"self",
".",
"vartype",
",",
... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | Constraint.projection | Create a new constraint that is the projection onto a subset of the variables.
Args:
variables (iterable):
Subset of the constraint's variables.
Returns:
:obj:`.Constraint`: A new constraint over a subset of the variables.
Examples:
>>> imp... | dwavebinarycsp/core/constraint.py | def projection(self, variables):
"""Create a new constraint that is the projection onto a subset of the variables.
Args:
variables (iterable):
Subset of the constraint's variables.
Returns:
:obj:`.Constraint`: A new constraint over a subset of the variab... | def projection(self, variables):
"""Create a new constraint that is the projection onto a subset of the variables.
Args:
variables (iterable):
Subset of the constraint's variables.
Returns:
:obj:`.Constraint`: A new constraint over a subset of the variab... | [
"Create",
"a",
"new",
"constraint",
"that",
"is",
"the",
"projection",
"onto",
"a",
"subset",
"of",
"the",
"variables",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/constraint.py#L497-L532 | [
"def",
"projection",
"(",
"self",
",",
"variables",
")",
":",
"# resolve iterables or mutability problems by casting the variables to a set",
"variables",
"=",
"set",
"(",
"variables",
")",
"if",
"not",
"variables",
".",
"issubset",
"(",
"self",
".",
"variables",
")",... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | multiplication_circuit | Multiplication circuit constraint satisfaction problem.
A constraint satisfaction problem that represents the binary multiplication :math:`ab=p`,
where the multiplicands are binary variables of length `nbit`; for example,
:math:`a_0 + 2a_1 + 4a_2 +... +2^ma_{nbit}`.
The square below shows a graphic re... | dwavebinarycsp/factories/csp/circuits.py | def multiplication_circuit(nbit, vartype=dimod.BINARY):
"""Multiplication circuit constraint satisfaction problem.
A constraint satisfaction problem that represents the binary multiplication :math:`ab=p`,
where the multiplicands are binary variables of length `nbit`; for example,
:math:`a_0 + 2a_1 + 4a... | def multiplication_circuit(nbit, vartype=dimod.BINARY):
"""Multiplication circuit constraint satisfaction problem.
A constraint satisfaction problem that represents the binary multiplication :math:`ab=p`,
where the multiplicands are binary variables of length `nbit`; for example,
:math:`a_0 + 2a_1 + 4a... | [
"Multiplication",
"circuit",
"constraint",
"satisfaction",
"problem",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/factories/csp/circuits.py#L28-L199 | [
"def",
"multiplication_circuit",
"(",
"nbit",
",",
"vartype",
"=",
"dimod",
".",
"BINARY",
")",
":",
"if",
"nbit",
"<",
"1",
":",
"raise",
"ValueError",
"(",
"\"num_multiplier_bits, num_multiplicand_bits must be positive integers\"",
")",
"num_multiplier_bits",
"=",
"... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | xor_fault | Returns True if XOR(a, b) == out and fault == 0 or XOR(a, b) != out and fault == 1. | examples/explicit_circuit_fault_diagnosis.py | def xor_fault(a, b, out, fault):
"""Returns True if XOR(a, b) == out and fault == 0 or XOR(a, b) != out and fault == 1."""
if (a != b) == out:
return fault == 0
else:
return fault == 1 | def xor_fault(a, b, out, fault):
"""Returns True if XOR(a, b) == out and fault == 0 or XOR(a, b) != out and fault == 1."""
if (a != b) == out:
return fault == 0
else:
return fault == 1 | [
"Returns",
"True",
"if",
"XOR",
"(",
"a",
"b",
")",
"==",
"out",
"and",
"fault",
"==",
"0",
"or",
"XOR",
"(",
"a",
"b",
")",
"!",
"=",
"out",
"and",
"fault",
"==",
"1",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/examples/explicit_circuit_fault_diagnosis.py#L6-L11 | [
"def",
"xor_fault",
"(",
"a",
",",
"b",
",",
"out",
",",
"fault",
")",
":",
"if",
"(",
"a",
"!=",
"b",
")",
"==",
"out",
":",
"return",
"fault",
"==",
"0",
"else",
":",
"return",
"fault",
"==",
"1"
] | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | and_fault | Returns True if AND(a, b) == out and fault == 0 or AND(a, b) != out and fault == 1. | examples/explicit_circuit_fault_diagnosis.py | def and_fault(a, b, out, fault):
"""Returns True if AND(a, b) == out and fault == 0 or AND(a, b) != out and fault == 1."""
if (a and b) == out:
return fault == 0
else:
return fault == 1 | def and_fault(a, b, out, fault):
"""Returns True if AND(a, b) == out and fault == 0 or AND(a, b) != out and fault == 1."""
if (a and b) == out:
return fault == 0
else:
return fault == 1 | [
"Returns",
"True",
"if",
"AND",
"(",
"a",
"b",
")",
"==",
"out",
"and",
"fault",
"==",
"0",
"or",
"AND",
"(",
"a",
"b",
")",
"!",
"=",
"out",
"and",
"fault",
"==",
"1",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/examples/explicit_circuit_fault_diagnosis.py#L14-L19 | [
"def",
"and_fault",
"(",
"a",
",",
"b",
",",
"out",
",",
"fault",
")",
":",
"if",
"(",
"a",
"and",
"b",
")",
"==",
"out",
":",
"return",
"fault",
"==",
"0",
"else",
":",
"return",
"fault",
"==",
"1"
] | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | or_fault | Returns True if OR(a, b) == out and fault == 0 or OR(a, b) != out and fault == 1. | examples/explicit_circuit_fault_diagnosis.py | def or_fault(a, b, out, fault):
"""Returns True if OR(a, b) == out and fault == 0 or OR(a, b) != out and fault == 1."""
if (a or b) == out:
return fault == 0
else:
return fault == 1 | def or_fault(a, b, out, fault):
"""Returns True if OR(a, b) == out and fault == 0 or OR(a, b) != out and fault == 1."""
if (a or b) == out:
return fault == 0
else:
return fault == 1 | [
"Returns",
"True",
"if",
"OR",
"(",
"a",
"b",
")",
"==",
"out",
"and",
"fault",
"==",
"0",
"or",
"OR",
"(",
"a",
"b",
")",
"!",
"=",
"out",
"and",
"fault",
"==",
"1",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/examples/explicit_circuit_fault_diagnosis.py#L22-L27 | [
"def",
"or_fault",
"(",
"a",
",",
"b",
",",
"out",
",",
"fault",
")",
":",
"if",
"(",
"a",
"or",
"b",
")",
"==",
"out",
":",
"return",
"fault",
"==",
"0",
"else",
":",
"return",
"fault",
"==",
"1"
] | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | assert_penaltymodel_factory_available | For `dwavebinarycsp` to be functional, at least one penalty model factory
has to be installed. See discussion in setup.py for details. | dwavebinarycsp/__init__.py | def assert_penaltymodel_factory_available():
"""For `dwavebinarycsp` to be functional, at least one penalty model factory
has to be installed. See discussion in setup.py for details.
"""
from pkg_resources import iter_entry_points
from penaltymodel.core import FACTORY_ENTRYPOINT
from itertools ... | def assert_penaltymodel_factory_available():
"""For `dwavebinarycsp` to be functional, at least one penalty model factory
has to be installed. See discussion in setup.py for details.
"""
from pkg_resources import iter_entry_points
from penaltymodel.core import FACTORY_ENTRYPOINT
from itertools ... | [
"For",
"dwavebinarycsp",
"to",
"be",
"functional",
"at",
"least",
"one",
"penalty",
"model",
"factory",
"has",
"to",
"be",
"installed",
".",
"See",
"discussion",
"in",
"setup",
".",
"py",
"for",
"details",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/__init__.py#L41-L60 | [
"def",
"assert_penaltymodel_factory_available",
"(",
")",
":",
"from",
"pkg_resources",
"import",
"iter_entry_points",
"from",
"penaltymodel",
".",
"core",
"import",
"FACTORY_ENTRYPOINT",
"from",
"itertools",
"import",
"chain",
"supported",
"=",
"(",
"'maxgap'",
",",
... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | add_constraint | Add a constraint.
Args:
constraint (function/iterable/:obj:`.Constraint`):
Constraint definition in one of the supported formats:
1. Function, with input arguments matching the order and
:attr:`~.ConstraintSatisfactionProblem.vartype` type of the ... | dwavebinarycsp/core/csp.py | def add_constraint(self, constraint, variables=tuple()):
"""Add a constraint.
Args:
constraint (function/iterable/:obj:`.Constraint`):
Constraint definition in one of the supported formats:
1. Function, with input arguments matching the order and
... | def add_constraint(self, constraint, variables=tuple()):
"""Add a constraint.
Args:
constraint (function/iterable/:obj:`.Constraint`):
Constraint definition in one of the supported formats:
1. Function, with input arguments matching the order and
... | [
"Add",
"a",
"constraint",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/core/csp.py#L76-L141 | [
"def",
"add_constraint",
"(",
"self",
",",
"constraint",
",",
"variables",
"=",
"tuple",
"(",
")",
")",
":",
"if",
"isinstance",
"(",
"constraint",
",",
"Constraint",
")",
":",
"if",
"variables",
"and",
"(",
"tuple",
"(",
"variables",
")",
"!=",
"constra... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | stitch | Build a binary quadratic model with minimal energy levels at solutions to the specified constraint satisfaction
problem.
Args:
csp (:obj:`.ConstraintSatisfactionProblem`):
Constraint satisfaction problem.
min_classical_gap (float, optional, default=2.0):
Minimum energy ... | dwavebinarycsp/compilers/stitcher.py | def stitch(csp, min_classical_gap=2.0, max_graph_size=8):
"""Build a binary quadratic model with minimal energy levels at solutions to the specified constraint satisfaction
problem.
Args:
csp (:obj:`.ConstraintSatisfactionProblem`):
Constraint satisfaction problem.
min_classica... | def stitch(csp, min_classical_gap=2.0, max_graph_size=8):
"""Build a binary quadratic model with minimal energy levels at solutions to the specified constraint satisfaction
problem.
Args:
csp (:obj:`.ConstraintSatisfactionProblem`):
Constraint satisfaction problem.
min_classica... | [
"Build",
"a",
"binary",
"quadratic",
"model",
"with",
"minimal",
"energy",
"levels",
"at",
"solutions",
"to",
"the",
"specified",
"constraint",
"satisfaction",
"problem",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/compilers/stitcher.py#L34-L196 | [
"def",
"stitch",
"(",
"csp",
",",
"min_classical_gap",
"=",
"2.0",
",",
"max_graph_size",
"=",
"8",
")",
":",
"# ensure we have penaltymodel factory available",
"try",
":",
"dwavebinarycsp",
".",
"assert_penaltymodel_factory_available",
"(",
")",
"except",
"AssertionErr... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | _bqm_from_1sat | create a bqm for a constraint with only one variable
bqm will have exactly classical gap 2. | dwavebinarycsp/compilers/stitcher.py | def _bqm_from_1sat(constraint):
"""create a bqm for a constraint with only one variable
bqm will have exactly classical gap 2.
"""
configurations = constraint.configurations
num_configurations = len(configurations)
bqm = dimod.BinaryQuadraticModel.empty(constraint.vartype)
if num_configur... | def _bqm_from_1sat(constraint):
"""create a bqm for a constraint with only one variable
bqm will have exactly classical gap 2.
"""
configurations = constraint.configurations
num_configurations = len(configurations)
bqm = dimod.BinaryQuadraticModel.empty(constraint.vartype)
if num_configur... | [
"create",
"a",
"bqm",
"for",
"a",
"constraint",
"with",
"only",
"one",
"variable"
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/compilers/stitcher.py#L199-L216 | [
"def",
"_bqm_from_1sat",
"(",
"constraint",
")",
":",
"configurations",
"=",
"constraint",
".",
"configurations",
"num_configurations",
"=",
"len",
"(",
"configurations",
")",
"bqm",
"=",
"dimod",
".",
"BinaryQuadraticModel",
".",
"empty",
"(",
"constraint",
".",
... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | _bqm_from_2sat | create a bqm for a constraint with two variables.
bqm will have exactly classical gap 2. | dwavebinarycsp/compilers/stitcher.py | def _bqm_from_2sat(constraint):
"""create a bqm for a constraint with two variables.
bqm will have exactly classical gap 2.
"""
configurations = constraint.configurations
variables = constraint.variables
vartype = constraint.vartype
u, v = constraint.variables
# if all configurations a... | def _bqm_from_2sat(constraint):
"""create a bqm for a constraint with two variables.
bqm will have exactly classical gap 2.
"""
configurations = constraint.configurations
variables = constraint.variables
vartype = constraint.vartype
u, v = constraint.variables
# if all configurations a... | [
"create",
"a",
"bqm",
"for",
"a",
"constraint",
"with",
"two",
"variables",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/compilers/stitcher.py#L219-L271 | [
"def",
"_bqm_from_2sat",
"(",
"constraint",
")",
":",
"configurations",
"=",
"constraint",
".",
"configurations",
"variables",
"=",
"constraint",
".",
"variables",
"vartype",
"=",
"constraint",
".",
"vartype",
"u",
",",
"v",
"=",
"constraint",
".",
"variables",
... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | iter_complete_graphs | Iterate over complete graphs.
Args:
start (int/iterable):
Define the size of the starting graph.
If an int, the nodes will be index-labeled, otherwise should be an iterable of node
labels.
stop (int):
Stops yielding graphs when the size equals stop.
... | dwavebinarycsp/compilers/stitcher.py | def iter_complete_graphs(start, stop, factory=None):
"""Iterate over complete graphs.
Args:
start (int/iterable):
Define the size of the starting graph.
If an int, the nodes will be index-labeled, otherwise should be an iterable of node
labels.
stop (int):
... | def iter_complete_graphs(start, stop, factory=None):
"""Iterate over complete graphs.
Args:
start (int/iterable):
Define the size of the starting graph.
If an int, the nodes will be index-labeled, otherwise should be an iterable of node
labels.
stop (int):
... | [
"Iterate",
"over",
"complete",
"graphs",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/compilers/stitcher.py#L275-L311 | [
"def",
"iter_complete_graphs",
"(",
"start",
",",
"stop",
",",
"factory",
"=",
"None",
")",
":",
"_",
",",
"nodes",
"=",
"start",
"nodes",
"=",
"list",
"(",
"nodes",
")",
"# we'll be appending",
"if",
"factory",
"is",
"None",
":",
"factory",
"=",
"count"... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | load_cnf | Load a constraint satisfaction problem from a .cnf file.
Args:
fp (file, optional):
`.write()`-supporting `file object`_ DIMACS CNF formatted_ file.
Returns:
:obj:`.ConstraintSatisfactionProblem` a binary-valued SAT problem.
Examples:
>>> import dwavebinarycsp as dbcs... | dwavebinarycsp/io/cnf.py | def load_cnf(fp):
"""Load a constraint satisfaction problem from a .cnf file.
Args:
fp (file, optional):
`.write()`-supporting `file object`_ DIMACS CNF formatted_ file.
Returns:
:obj:`.ConstraintSatisfactionProblem` a binary-valued SAT problem.
Examples:
>>> impo... | def load_cnf(fp):
"""Load a constraint satisfaction problem from a .cnf file.
Args:
fp (file, optional):
`.write()`-supporting `file object`_ DIMACS CNF formatted_ file.
Returns:
:obj:`.ConstraintSatisfactionProblem` a binary-valued SAT problem.
Examples:
>>> impo... | [
"Load",
"a",
"constraint",
"satisfaction",
"problem",
"from",
"a",
".",
"cnf",
"file",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/io/cnf.py#L29-L95 | [
"def",
"load_cnf",
"(",
"fp",
")",
":",
"fp",
"=",
"iter",
"(",
"fp",
")",
"# handle lists/tuples/etc",
"csp",
"=",
"ConstraintSatisfactionProblem",
"(",
"dimod",
".",
"BINARY",
")",
"# first look for the problem",
"num_clauses",
"=",
"num_variables",
"=",
"0",
... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | and_gate | AND gate.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, out]`,
where `in1, in2` are inputs and `out` the gate's output.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
input values:
* Vartype.SPIN, 'SPIN', {-1, 1}... | dwavebinarycsp/factories/constraint/gates.py | def and_gate(variables, vartype=dimod.BINARY, name='AND'):
"""AND gate.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, out]`,
where `in1, in2` are inputs and `out` the gate's output.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
... | def and_gate(variables, vartype=dimod.BINARY, name='AND'):
"""AND gate.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, out]`,
where `in1, in2` are inputs and `out` the gate's output.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
... | [
"AND",
"gate",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/factories/constraint/gates.py#L29-L74 | [
"def",
"and_gate",
"(",
"variables",
",",
"vartype",
"=",
"dimod",
".",
"BINARY",
",",
"name",
"=",
"'AND'",
")",
":",
"variables",
"=",
"tuple",
"(",
"variables",
")",
"if",
"vartype",
"is",
"dimod",
".",
"BINARY",
":",
"configurations",
"=",
"frozenset... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | xor_gate | XOR gate.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, out]`,
where `in1, in2` are inputs and `out` the gate's output.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
input values:
* Vartype.SPIN, 'SPIN', {-1, 1}... | dwavebinarycsp/factories/constraint/gates.py | def xor_gate(variables, vartype=dimod.BINARY, name='XOR'):
"""XOR gate.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, out]`,
where `in1, in2` are inputs and `out` the gate's output.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
... | def xor_gate(variables, vartype=dimod.BINARY, name='XOR'):
"""XOR gate.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, out]`,
where `in1, in2` are inputs and `out` the gate's output.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
... | [
"XOR",
"gate",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/factories/constraint/gates.py#L127-L171 | [
"def",
"xor_gate",
"(",
"variables",
",",
"vartype",
"=",
"dimod",
".",
"BINARY",
",",
"name",
"=",
"'XOR'",
")",
":",
"variables",
"=",
"tuple",
"(",
"variables",
")",
"if",
"vartype",
"is",
"dimod",
".",
"BINARY",
":",
"configs",
"=",
"frozenset",
"(... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | halfadder_gate | Half adder.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, sum, carry]`,
where `in1, in2` are inputs to be added and `sum` and 'carry' the resultant
outputs.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
input val... | dwavebinarycsp/factories/constraint/gates.py | def halfadder_gate(variables, vartype=dimod.BINARY, name='HALF_ADDER'):
"""Half adder.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, sum, carry]`,
where `in1, in2` are inputs to be added and `sum` and 'carry' the resultant
outputs.
vartype (Vart... | def halfadder_gate(variables, vartype=dimod.BINARY, name='HALF_ADDER'):
"""Half adder.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, sum, carry]`,
where `in1, in2` are inputs to be added and `sum` and 'carry' the resultant
outputs.
vartype (Vart... | [
"Half",
"adder",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/factories/constraint/gates.py#L175-L229 | [
"def",
"halfadder_gate",
"(",
"variables",
",",
"vartype",
"=",
"dimod",
".",
"BINARY",
",",
"name",
"=",
"'HALF_ADDER'",
")",
":",
"variables",
"=",
"tuple",
"(",
"variables",
")",
"if",
"vartype",
"is",
"dimod",
".",
"BINARY",
":",
"configs",
"=",
"fro... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
valid | fulladder_gate | Full adder.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, in3, sum, carry]`,
where `in1, in2, in3` are inputs to be added and `sum` and 'carry' the resultant
outputs.
vartype (Vartype, optional, default='BINARY'): Variable type. Accepted
... | dwavebinarycsp/factories/constraint/gates.py | def fulladder_gate(variables, vartype=dimod.BINARY, name='FULL_ADDER'):
"""Full adder.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, in3, sum, carry]`,
where `in1, in2, in3` are inputs to be added and `sum` and 'carry' the resultant
outputs.
var... | def fulladder_gate(variables, vartype=dimod.BINARY, name='FULL_ADDER'):
"""Full adder.
Args:
variables (list): Variable labels for the and gate as `[in1, in2, in3, sum, carry]`,
where `in1, in2, in3` are inputs to be added and `sum` and 'carry' the resultant
outputs.
var... | [
"Full",
"adder",
"."
] | dwavesystems/dwavebinarycsp | python | https://github.com/dwavesystems/dwavebinarycsp/blob/d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2/dwavebinarycsp/factories/constraint/gates.py#L233-L297 | [
"def",
"fulladder_gate",
"(",
"variables",
",",
"vartype",
"=",
"dimod",
".",
"BINARY",
",",
"name",
"=",
"'FULL_ADDER'",
")",
":",
"variables",
"=",
"tuple",
"(",
"variables",
")",
"if",
"vartype",
"is",
"dimod",
".",
"BINARY",
":",
"configs",
"=",
"fro... | d6b1e70ceaa8f451d7afaa87ea10c7fc948a64e2 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.