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 |
|---|---|---|---|---|---|---|---|---|---|---|---|
test | SdScanningClient.query_image_metadata | **Description**
Find the image with the tag <image> and return its metadata.
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- metadata_type: The metadata type can be one of the types returned by running without a type specified
... | sdcclient/_scanning.py | def query_image_metadata(self, image, metadata_type=""):
'''**Description**
Find the image with the tag <image> and return its metadata.
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- metadata_type: The metadata type can be on... | def query_image_metadata(self, image, metadata_type=""):
'''**Description**
Find the image with the tag <image> and return its metadata.
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- metadata_type: The metadata type can be on... | [
"**",
"Description",
"**",
"Find",
"the",
"image",
"with",
"the",
"tag",
"<image",
">",
"and",
"return",
"its",
"metadata",
"."
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L139-L150 | [
"def",
"query_image_metadata",
"(",
"self",
",",
"image",
",",
"metadata_type",
"=",
"\"\"",
")",
":",
"return",
"self",
".",
"_query_image",
"(",
"image",
",",
"query_group",
"=",
"'metadata'",
",",
"query_type",
"=",
"metadata_type",
")"
] | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.query_image_vuln | **Description**
Find the image with the tag <image> and return its vulnerabilities.
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- vuln_type: Vulnerability type can be one of the following types:
- os: CVE/distro vulne... | sdcclient/_scanning.py | def query_image_vuln(self, image, vuln_type="", vendor_only=True):
'''**Description**
Find the image with the tag <image> and return its vulnerabilities.
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- vuln_type: Vulnerability ... | def query_image_vuln(self, image, vuln_type="", vendor_only=True):
'''**Description**
Find the image with the tag <image> and return its vulnerabilities.
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- vuln_type: Vulnerability ... | [
"**",
"Description",
"**",
"Find",
"the",
"image",
"with",
"the",
"tag",
"<image",
">",
"and",
"return",
"its",
"vulnerabilities",
"."
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L152-L164 | [
"def",
"query_image_vuln",
"(",
"self",
",",
"image",
",",
"vuln_type",
"=",
"\"\"",
",",
"vendor_only",
"=",
"True",
")",
":",
"return",
"self",
".",
"_query_image",
"(",
"image",
",",
"query_group",
"=",
"'vuln'",
",",
"query_type",
"=",
"vuln_type",
","... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.delete_image | **Description**
Delete image from the scanner.
**Arguments**
- None | sdcclient/_scanning.py | def delete_image(self, image, force=False):
'''**Description**
Delete image from the scanner.
**Arguments**
- None
'''
_, _, image_digest = self._discover_inputimage(image)
if not image_digest:
return [False, "cannot use input image string: no... | def delete_image(self, image, force=False):
'''**Description**
Delete image from the scanner.
**Arguments**
- None
'''
_, _, image_digest = self._discover_inputimage(image)
if not image_digest:
return [False, "cannot use input image string: no... | [
"**",
"Description",
"**",
"Delete",
"image",
"from",
"the",
"scanner",
"."
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L187-L203 | [
"def",
"delete_image",
"(",
"self",
",",
"image",
",",
"force",
"=",
"False",
")",
":",
"_",
",",
"_",
",",
"image_digest",
"=",
"self",
".",
"_discover_inputimage",
"(",
"image",
")",
"if",
"not",
"image_digest",
":",
"return",
"[",
"False",
",",
"\"c... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.check_image_evaluation | **Description**
Check the latest policy evaluation for an image
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- show_history: Show all previous policy evaluations
- detail: Show detailed policy evaluation report
... | sdcclient/_scanning.py | def check_image_evaluation(self, image, show_history=False, detail=False, tag=None, policy=None):
'''**Description**
Check the latest policy evaluation for an image
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- show_history: ... | def check_image_evaluation(self, image, show_history=False, detail=False, tag=None, policy=None):
'''**Description**
Check the latest policy evaluation for an image
**Arguments**
- image: Input image can be in the following formats: registry/repo:tag
- show_history: ... | [
"**",
"Description",
"**",
"Check",
"the",
"latest",
"policy",
"evaluation",
"for",
"an",
"image"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L205-L240 | [
"def",
"check_image_evaluation",
"(",
"self",
",",
"image",
",",
"show_history",
"=",
"False",
",",
"detail",
"=",
"False",
",",
"tag",
"=",
"None",
",",
"policy",
"=",
"None",
")",
":",
"itype",
",",
"_",
",",
"image_digest",
"=",
"self",
".",
"_disco... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.add_registry | **Description**
Add image registry
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
- registry_user: Username
- registry_pass: Password
- insecure: Allow connection to registry without SSL cert checks (ex: if regis... | sdcclient/_scanning.py | def add_registry(self, registry, registry_user, registry_pass, insecure=False, registry_type="docker_v2", validate=True):
'''**Description**
Add image registry
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
- registry_user: User... | def add_registry(self, registry, registry_user, registry_pass, insecure=False, registry_type="docker_v2", validate=True):
'''**Description**
Add image registry
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
- registry_user: User... | [
"**",
"Description",
"**",
"Add",
"image",
"registry"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L242-L280 | [
"def",
"add_registry",
"(",
"self",
",",
"registry",
",",
"registry_user",
",",
"registry_pass",
",",
"insecure",
"=",
"False",
",",
"registry_type",
"=",
"\"docker_v2\"",
",",
"validate",
"=",
"True",
")",
":",
"registry_types",
"=",
"[",
"'docker_v2'",
",",
... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.update_registry | **Description**
Update an existing image registry.
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
- registry_user: Username
- registry_pass: Password
- insecure: Allow connection to registry without SSL cert chec... | sdcclient/_scanning.py | def update_registry(self, registry, registry_user, registry_pass, insecure=False, registry_type="docker_v2", validate=True):
'''**Description**
Update an existing image registry.
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
- ... | def update_registry(self, registry, registry_user, registry_pass, insecure=False, registry_type="docker_v2", validate=True):
'''**Description**
Update an existing image registry.
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
- ... | [
"**",
"Description",
"**",
"Update",
"an",
"existing",
"image",
"registry",
"."
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L282-L315 | [
"def",
"update_registry",
"(",
"self",
",",
"registry",
",",
"registry_user",
",",
"registry_pass",
",",
"insecure",
"=",
"False",
",",
"registry_type",
"=",
"\"docker_v2\"",
",",
"validate",
"=",
"True",
")",
":",
"if",
"self",
".",
"_registry_string_is_valid",... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.delete_registry | **Description**
Delete an existing image registry
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000 | sdcclient/_scanning.py | def delete_registry(self, registry):
'''**Description**
Delete an existing image registry
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
'''
# do some input string checking
if re.match(".*\\/.*", registry):
... | def delete_registry(self, registry):
'''**Description**
Delete an existing image registry
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
'''
# do some input string checking
if re.match(".*\\/.*", registry):
... | [
"**",
"Description",
"**",
"Delete",
"an",
"existing",
"image",
"registry"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L317-L333 | [
"def",
"delete_registry",
"(",
"self",
",",
"registry",
")",
":",
"# do some input string checking",
"if",
"re",
".",
"match",
"(",
"\".*\\\\/.*\"",
",",
"registry",
")",
":",
"return",
"[",
"False",
",",
"\"input registry name cannot contain '/' characters - valid regi... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.get_registry | **Description**
Find the registry and return its json description
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
**Success Return Value**
A JSON object representing the registry. | sdcclient/_scanning.py | def get_registry(self, registry):
'''**Description**
Find the registry and return its json description
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
**Success Return Value**
A JSON object representing the registry.
... | def get_registry(self, registry):
'''**Description**
Find the registry and return its json description
**Arguments**
- registry: Full hostname/port of registry. Eg. myrepo.example.com:5000
**Success Return Value**
A JSON object representing the registry.
... | [
"**",
"Description",
"**",
"Find",
"the",
"registry",
"and",
"return",
"its",
"json",
"description"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L352-L370 | [
"def",
"get_registry",
"(",
"self",
",",
"registry",
")",
":",
"if",
"self",
".",
"_registry_string_is_valid",
"(",
"registry",
")",
":",
"return",
"[",
"False",
",",
"\"input registry name cannot contain '/' characters - valid registry names are of the form <host>:<port> whe... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.add_policy | **Description**
Create a new policy
**Arguments**
- name: The name of the policy.
- rules: A list of Anchore PolicyRule elements (while creating/updating a policy, new rule IDs will be created backend side)
- comment: A human-readable description.
- b... | sdcclient/_scanning.py | def add_policy(self, name, rules, comment="", bundleid=None):
'''**Description**
Create a new policy
**Arguments**
- name: The name of the policy.
- rules: A list of Anchore PolicyRule elements (while creating/updating a policy, new rule IDs will be created backend s... | def add_policy(self, name, rules, comment="", bundleid=None):
'''**Description**
Create a new policy
**Arguments**
- name: The name of the policy.
- rules: A list of Anchore PolicyRule elements (while creating/updating a policy, new rule IDs will be created backend s... | [
"**",
"Description",
"**",
"Create",
"a",
"new",
"policy"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L380-L408 | [
"def",
"add_policy",
"(",
"self",
",",
"name",
",",
"rules",
",",
"comment",
"=",
"\"\"",
",",
"bundleid",
"=",
"None",
")",
":",
"policy",
"=",
"{",
"'name'",
":",
"name",
",",
"'comment'",
":",
"comment",
",",
"'rules'",
":",
"rules",
",",
"'versio... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.get_policy | **Description**
Retrieve the policy with the given id in the targeted policy bundle
**Arguments**
- policyid: Unique identifier associated with this policy.
- bundleid: Target bundle. If not specified, the currently active bundle will be used.
**Success Return Value... | sdcclient/_scanning.py | def get_policy(self, policyid, bundleid=None):
'''**Description**
Retrieve the policy with the given id in the targeted policy bundle
**Arguments**
- policyid: Unique identifier associated with this policy.
- bundleid: Target bundle. If not specified, the currently a... | def get_policy(self, policyid, bundleid=None):
'''**Description**
Retrieve the policy with the given id in the targeted policy bundle
**Arguments**
- policyid: Unique identifier associated with this policy.
- bundleid: Target bundle. If not specified, the currently a... | [
"**",
"Description",
"**",
"Retrieve",
"the",
"policy",
"with",
"the",
"given",
"id",
"in",
"the",
"targeted",
"policy",
"bundle"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L440-L453 | [
"def",
"get_policy",
"(",
"self",
",",
"policyid",
",",
"bundleid",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"url",
"+",
"'/api/scanning/v1/policies/'",
"+",
"policyid",
"if",
"bundleid",
":",
"url",
"+=",
"'?bundleId='",
"+",
"bundleid"
] | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.update_policy | **Description**
Update the policy with the given id
**Arguments**
- policyid: Unique identifier associated with this policy.
- policy_description: A dictionary with the policy description.
**Success Return Value**
A JSON object containing the policy desc... | sdcclient/_scanning.py | def update_policy(self, policyid, policy_description):
'''**Description**
Update the policy with the given id
**Arguments**
- policyid: Unique identifier associated with this policy.
- policy_description: A dictionary with the policy description.
**Success R... | def update_policy(self, policyid, policy_description):
'''**Description**
Update the policy with the given id
**Arguments**
- policyid: Unique identifier associated with this policy.
- policy_description: A dictionary with the policy description.
**Success R... | [
"**",
"Description",
"**",
"Update",
"the",
"policy",
"with",
"the",
"given",
"id"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L455-L472 | [
"def",
"update_policy",
"(",
"self",
",",
"policyid",
",",
"policy_description",
")",
":",
"url",
"=",
"self",
".",
"url",
"+",
"'/api/scanning/v1/policies/'",
"+",
"policyid",
"data",
"=",
"json",
".",
"dumps",
"(",
"policy_description",
")",
"res",
"=",
"r... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.add_alert | **Description**
Create a new alert
**Arguments**
- name: The name of the alert.
- description: The descprition of the alert.
- scope: An AND-composed string of predicates that selects the scope in which the alert will be applied. (like: 'host.domain = "example.co... | sdcclient/_scanning.py | def add_alert(self, name, description=None, scope="", triggers={'failed': True, 'unscanned': True},
enabled=False, notification_channels=[]):
'''**Description**
Create a new alert
**Arguments**
- name: The name of the alert.
- description: The descp... | def add_alert(self, name, description=None, scope="", triggers={'failed': True, 'unscanned': True},
enabled=False, notification_channels=[]):
'''**Description**
Create a new alert
**Arguments**
- name: The name of the alert.
- description: The descp... | [
"**",
"Description",
"**",
"Create",
"a",
"new",
"alert"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L492-L524 | [
"def",
"add_alert",
"(",
"self",
",",
"name",
",",
"description",
"=",
"None",
",",
"scope",
"=",
"\"\"",
",",
"triggers",
"=",
"{",
"'failed'",
":",
"True",
",",
"'unscanned'",
":",
"True",
"}",
",",
"enabled",
"=",
"False",
",",
"notification_channels"... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.list_alerts | **Description**
List the current set of scanning alerts.
**Arguments**
- limit: Maximum number of alerts in the response.
- cursor: An opaque string representing the current position in the list of alerts. It's provided in the 'responseMetadata' of the list_alerts response.
... | sdcclient/_scanning.py | def list_alerts(self, limit=None, cursor=None):
'''**Description**
List the current set of scanning alerts.
**Arguments**
- limit: Maximum number of alerts in the response.
- cursor: An opaque string representing the current position in the list of alerts. It's provi... | def list_alerts(self, limit=None, cursor=None):
'''**Description**
List the current set of scanning alerts.
**Arguments**
- limit: Maximum number of alerts in the response.
- cursor: An opaque string representing the current position in the list of alerts. It's provi... | [
"**",
"Description",
"**",
"List",
"the",
"current",
"set",
"of",
"scanning",
"alerts",
"."
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L526-L547 | [
"def",
"list_alerts",
"(",
"self",
",",
"limit",
"=",
"None",
",",
"cursor",
"=",
"None",
")",
":",
"url",
"=",
"self",
".",
"url",
"+",
"'/api/scanning/v1/alerts'",
"if",
"limit",
":",
"url",
"+=",
"'?limit='",
"+",
"str",
"(",
"limit",
")",
"if",
"... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.update_alert | **Description**
Update the alert with the given id
**Arguments**
- alertid: Unique identifier associated with this alert.
- alert_description: A dictionary with the alert description.
**Success Return Value**
A JSON object containing the alert descriptio... | sdcclient/_scanning.py | def update_alert(self, alertid, alert_description):
'''**Description**
Update the alert with the given id
**Arguments**
- alertid: Unique identifier associated with this alert.
- alert_description: A dictionary with the alert description.
**Success Return Va... | def update_alert(self, alertid, alert_description):
'''**Description**
Update the alert with the given id
**Arguments**
- alertid: Unique identifier associated with this alert.
- alert_description: A dictionary with the alert description.
**Success Return Va... | [
"**",
"Description",
"**",
"Update",
"the",
"alert",
"with",
"the",
"given",
"id"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L566-L583 | [
"def",
"update_alert",
"(",
"self",
",",
"alertid",
",",
"alert_description",
")",
":",
"url",
"=",
"self",
".",
"url",
"+",
"'/api/scanning/v1/alerts/'",
"+",
"alertid",
"data",
"=",
"json",
".",
"dumps",
"(",
"alert_description",
")",
"res",
"=",
"requests... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.delete_alert | **Description**
Delete the alert with the given id
**Arguments**
- alertid: Unique identifier associated with this alert. | sdcclient/_scanning.py | def delete_alert(self, policyid):
'''**Description**
Delete the alert with the given id
**Arguments**
- alertid: Unique identifier associated with this alert.
'''
url = self.url + '/api/scanning/v1/alerts/' + policyid
res = requests.delete(url, headers=se... | def delete_alert(self, policyid):
'''**Description**
Delete the alert with the given id
**Arguments**
- alertid: Unique identifier associated with this alert.
'''
url = self.url + '/api/scanning/v1/alerts/' + policyid
res = requests.delete(url, headers=se... | [
"**",
"Description",
"**",
"Delete",
"the",
"alert",
"with",
"the",
"given",
"id"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L585-L597 | [
"def",
"delete_alert",
"(",
"self",
",",
"policyid",
")",
":",
"url",
"=",
"self",
".",
"url",
"+",
"'/api/scanning/v1/alerts/'",
"+",
"policyid",
"res",
"=",
"requests",
".",
"delete",
"(",
"url",
",",
"headers",
"=",
"self",
".",
"hdrs",
",",
"verify",... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.list_subscription | **Description**
List all subscriptions
**Arguments**
- None
**Success Return Value**
A JSON object representing the list of subscriptions. | sdcclient/_scanning.py | def list_subscription(self):
'''**Description**
List all subscriptions
**Arguments**
- None
**Success Return Value**
A JSON object representing the list of subscriptions.
'''
url = self.url + "/api/scanning/v1/anchore/subscriptions"
r... | def list_subscription(self):
'''**Description**
List all subscriptions
**Arguments**
- None
**Success Return Value**
A JSON object representing the list of subscriptions.
'''
url = self.url + "/api/scanning/v1/anchore/subscriptions"
r... | [
"**",
"Description",
"**",
"List",
"all",
"subscriptions"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L637-L652 | [
"def",
"list_subscription",
"(",
"self",
")",
":",
"url",
"=",
"self",
".",
"url",
"+",
"\"/api/scanning/v1/anchore/subscriptions\"",
"res",
"=",
"requests",
".",
"get",
"(",
"url",
",",
"headers",
"=",
"self",
".",
"hdrs",
",",
"verify",
"=",
"self",
".",... | 47f83415842048778939b90944f64386a3bcb205 |
test | SdScanningClient.list_runtime | **Description**
List runtime containers
**Arguments**
- scope: An AND-composed string of predicates that selects the scope in which the alert will be applied. (like: 'host.domain = "example.com" and container.image != "alpine:latest"')
- skip_policy_evaluation: If true, no p... | sdcclient/_scanning.py | def list_runtime(self, scope="", skip_policy_evaluation=True, start_time=None, end_time=None):
'''**Description**
List runtime containers
**Arguments**
- scope: An AND-composed string of predicates that selects the scope in which the alert will be applied. (like: 'host.domain = ... | def list_runtime(self, scope="", skip_policy_evaluation=True, start_time=None, end_time=None):
'''**Description**
List runtime containers
**Arguments**
- scope: An AND-composed string of predicates that selects the scope in which the alert will be applied. (like: 'host.domain = ... | [
"**",
"Description",
"**",
"List",
"runtime",
"containers"
] | draios/python-sdc-client | python | https://github.com/draios/python-sdc-client/blob/47f83415842048778939b90944f64386a3bcb205/sdcclient/_scanning.py#L654-L683 | [
"def",
"list_runtime",
"(",
"self",
",",
"scope",
"=",
"\"\"",
",",
"skip_policy_evaluation",
"=",
"True",
",",
"start_time",
"=",
"None",
",",
"end_time",
"=",
"None",
")",
":",
"containers",
"=",
"{",
"'scope'",
":",
"scope",
",",
"'skipPolicyEvaluation'",... | 47f83415842048778939b90944f64386a3bcb205 |
test | NetworkingThread.addSourceAddr | None means 'system default | wsdiscovery/daemon.py | def addSourceAddr(self, addr):
"""None means 'system default'"""
try:
self._multiInSocket.setsockopt(socket.IPPROTO_IP, socket.IP_ADD_MEMBERSHIP, self._makeMreq(addr))
except socket.error: # if 1 interface has more than 1 address, exception is raised for the second
pass
... | def addSourceAddr(self, addr):
"""None means 'system default'"""
try:
self._multiInSocket.setsockopt(socket.IPPROTO_IP, socket.IP_ADD_MEMBERSHIP, self._makeMreq(addr))
except socket.error: # if 1 interface has more than 1 address, exception is raised for the second
pass
... | [
"None",
"means",
"system",
"default"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/daemon.py#L126-L135 | [
"def",
"addSourceAddr",
"(",
"self",
",",
"addr",
")",
":",
"try",
":",
"self",
".",
"_multiInSocket",
".",
"setsockopt",
"(",
"socket",
".",
"IPPROTO_IP",
",",
"socket",
".",
"IP_ADD_MEMBERSHIP",
",",
"self",
".",
"_makeMreq",
"(",
"addr",
")",
")",
"ex... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | NetworkingThread._sendPendingMessages | Method sleeps, if nothing to do | wsdiscovery/daemon.py | def _sendPendingMessages(self):
"""Method sleeps, if nothing to do"""
if len(self._queue) == 0:
time.sleep(0.1)
return
msg = self._queue.pop(0)
if msg.canSend():
self._sendMsg(msg)
msg.refresh()
if not (msg.isFinished()):
... | def _sendPendingMessages(self):
"""Method sleeps, if nothing to do"""
if len(self._queue) == 0:
time.sleep(0.1)
return
msg = self._queue.pop(0)
if msg.canSend():
self._sendMsg(msg)
msg.refresh()
if not (msg.isFinished()):
... | [
"Method",
"sleeps",
"if",
"nothing",
"to",
"do"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/daemon.py#L232-L245 | [
"def",
"_sendPendingMessages",
"(",
"self",
")",
":",
"if",
"len",
"(",
"self",
".",
"_queue",
")",
"==",
"0",
":",
"time",
".",
"sleep",
"(",
"0.1",
")",
"return",
"msg",
"=",
"self",
".",
"_queue",
".",
"pop",
"(",
"0",
")",
"if",
"msg",
".",
... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | WSDiscovery.setRemoteServiceHelloCallback | Set callback, which will be called when new service appeared online
and sent Hi message
typesFilter and scopesFilter might be list of types and scopes.
If filter is set, callback is called only for Hello messages,
which match filter
Set None to disable callback | wsdiscovery/daemon.py | def setRemoteServiceHelloCallback(self, cb, types=None, scopes=None):
"""Set callback, which will be called when new service appeared online
and sent Hi message
typesFilter and scopesFilter might be list of types and scopes.
If filter is set, callback is called only for Hello messages,
... | def setRemoteServiceHelloCallback(self, cb, types=None, scopes=None):
"""Set callback, which will be called when new service appeared online
and sent Hi message
typesFilter and scopesFilter might be list of types and scopes.
If filter is set, callback is called only for Hello messages,
... | [
"Set",
"callback",
"which",
"will",
"be",
"called",
"when",
"new",
"service",
"appeared",
"online",
"and",
"sent",
"Hi",
"message"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/daemon.py#L291-L303 | [
"def",
"setRemoteServiceHelloCallback",
"(",
"self",
",",
"cb",
",",
"types",
"=",
"None",
",",
"scopes",
"=",
"None",
")",
":",
"self",
".",
"_remoteServiceHelloCallback",
"=",
"cb",
"self",
".",
"_remoteServiceHelloCallbackTypesFilter",
"=",
"types",
"self",
"... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | WSDiscovery.stop | cleans up and stops the discovery server | wsdiscovery/daemon.py | def stop(self):
'cleans up and stops the discovery server'
self.clearRemoteServices()
self.clearLocalServices()
self._stopThreads()
self._serverStarted = False | def stop(self):
'cleans up and stops the discovery server'
self.clearRemoteServices()
self.clearLocalServices()
self._stopThreads()
self._serverStarted = False | [
"cleans",
"up",
"and",
"stops",
"the",
"discovery",
"server"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/daemon.py#L473-L480 | [
"def",
"stop",
"(",
"self",
")",
":",
"self",
".",
"clearRemoteServices",
"(",
")",
"self",
".",
"clearLocalServices",
"(",
")",
"self",
".",
"_stopThreads",
"(",
")",
"self",
".",
"_serverStarted",
"=",
"False"
] | a7b852cf43115c6f986e509b1870d6963e76687f |
test | WSDiscovery.clearLocalServices | send Bye messages for the services and remove them | wsdiscovery/daemon.py | def clearLocalServices(self):
'send Bye messages for the services and remove them'
for service in list(self._localServices.values()):
self._sendBye(service)
self._localServices.clear() | def clearLocalServices(self):
'send Bye messages for the services and remove them'
for service in list(self._localServices.values()):
self._sendBye(service)
self._localServices.clear() | [
"send",
"Bye",
"messages",
"for",
"the",
"services",
"and",
"remove",
"them"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/daemon.py#L547-L553 | [
"def",
"clearLocalServices",
"(",
"self",
")",
":",
"for",
"service",
"in",
"list",
"(",
"self",
".",
"_localServices",
".",
"values",
"(",
")",
")",
":",
"self",
".",
"_sendBye",
"(",
"service",
")",
"self",
".",
"_localServices",
".",
"clear",
"(",
"... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | WSDiscovery.searchServices | search for services given the TYPES and SCOPES in a given TIMEOUT | wsdiscovery/daemon.py | def searchServices(self, types=None, scopes=None, timeout=3):
'search for services given the TYPES and SCOPES in a given TIMEOUT'
if not self._serverStarted:
raise Exception("Server not started")
self._sendProbe(types, scopes)
time.sleep(timeout)
return self._filt... | def searchServices(self, types=None, scopes=None, timeout=3):
'search for services given the TYPES and SCOPES in a given TIMEOUT'
if not self._serverStarted:
raise Exception("Server not started")
self._sendProbe(types, scopes)
time.sleep(timeout)
return self._filt... | [
"search",
"for",
"services",
"given",
"the",
"TYPES",
"and",
"SCOPES",
"in",
"a",
"given",
"TIMEOUT"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/daemon.py#L555-L565 | [
"def",
"searchServices",
"(",
"self",
",",
"types",
"=",
"None",
",",
"scopes",
"=",
"None",
",",
"timeout",
"=",
"3",
")",
":",
"if",
"not",
"self",
".",
"_serverStarted",
":",
"raise",
"Exception",
"(",
"\"Server not started\"",
")",
"self",
".",
"_sen... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | WSDiscovery.publishService | Publish a service with the given TYPES, SCOPES and XAddrs (service addresses)
if xAddrs contains item, which includes {ip} pattern, one item per IP addres will be sent | wsdiscovery/daemon.py | def publishService(self, types, scopes, xAddrs):
"""Publish a service with the given TYPES, SCOPES and XAddrs (service addresses)
if xAddrs contains item, which includes {ip} pattern, one item per IP addres will be sent
"""
if not self._serverStarted:
raise Exception("Serve... | def publishService(self, types, scopes, xAddrs):
"""Publish a service with the given TYPES, SCOPES and XAddrs (service addresses)
if xAddrs contains item, which includes {ip} pattern, one item per IP addres will be sent
"""
if not self._serverStarted:
raise Exception("Serve... | [
"Publish",
"a",
"service",
"with",
"the",
"given",
"TYPES",
"SCOPES",
"and",
"XAddrs",
"(",
"service",
"addresses",
")"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/daemon.py#L567-L582 | [
"def",
"publishService",
"(",
"self",
",",
"types",
",",
"scopes",
",",
"xAddrs",
")",
":",
"if",
"not",
"self",
".",
"_serverStarted",
":",
"raise",
"Exception",
"(",
"\"Server not started\"",
")",
"instanceId",
"=",
"_generateInstanceId",
"(",
")",
"service"... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | createSOAPMessage | construct a a raw SOAP XML string, given a prepared SoapEnvelope object | wsdiscovery/message.py | def createSOAPMessage(env):
"construct a a raw SOAP XML string, given a prepared SoapEnvelope object"
if env.getAction() == ACTION_PROBE:
return createProbeMessage(env)
if env.getAction() == ACTION_PROBE_MATCH:
return createProbeMatchMessage(env)
if env.getAction() == ACTION_RESOLVE:
... | def createSOAPMessage(env):
"construct a a raw SOAP XML string, given a prepared SoapEnvelope object"
if env.getAction() == ACTION_PROBE:
return createProbeMessage(env)
if env.getAction() == ACTION_PROBE_MATCH:
return createProbeMatchMessage(env)
if env.getAction() == ACTION_RESOLVE:
... | [
"construct",
"a",
"a",
"raw",
"SOAP",
"XML",
"string",
"given",
"a",
"prepared",
"SoapEnvelope",
"object"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/message.py#L11-L24 | [
"def",
"createSOAPMessage",
"(",
"env",
")",
":",
"if",
"env",
".",
"getAction",
"(",
")",
"==",
"ACTION_PROBE",
":",
"return",
"createProbeMessage",
"(",
"env",
")",
"if",
"env",
".",
"getAction",
"(",
")",
"==",
"ACTION_PROBE_MATCH",
":",
"return",
"crea... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | parseSOAPMessage | parse raw XML data string, return a (minidom) xml document | wsdiscovery/message.py | def parseSOAPMessage(data, ipAddr):
"parse raw XML data string, return a (minidom) xml document"
try:
dom = minidom.parseString(data)
except Exception:
#print('Failed to parse message from %s\n"%s": %s' % (ipAddr, data, ex), file=sys.stderr)
return None
if dom.getElementsByTagN... | def parseSOAPMessage(data, ipAddr):
"parse raw XML data string, return a (minidom) xml document"
try:
dom = minidom.parseString(data)
except Exception:
#print('Failed to parse message from %s\n"%s": %s' % (ipAddr, data, ex), file=sys.stderr)
return None
if dom.getElementsByTagN... | [
"parse",
"raw",
"XML",
"data",
"string",
"return",
"a",
"(",
"minidom",
")",
"xml",
"document"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/message.py#L27-L52 | [
"def",
"parseSOAPMessage",
"(",
"data",
",",
"ipAddr",
")",
":",
"try",
":",
"dom",
"=",
"minidom",
".",
"parseString",
"(",
"data",
")",
"except",
"Exception",
":",
"#print('Failed to parse message from %s\\n\"%s\": %s' % (ipAddr, data, ex), file=sys.stderr)",
"return",
... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | discover | Discover systems using WS-Discovery | wsdiscovery/cmdline.py | def discover(scope, loglevel, capture):
"Discover systems using WS-Discovery"
if loglevel:
level = getattr(logging, loglevel, None)
if not level:
print("Invalid log level '%s'" % loglevel)
return
logger.setLevel(level)
run(scope=scope, capture=capture) | def discover(scope, loglevel, capture):
"Discover systems using WS-Discovery"
if loglevel:
level = getattr(logging, loglevel, None)
if not level:
print("Invalid log level '%s'" % loglevel)
return
logger.setLevel(level)
run(scope=scope, capture=capture) | [
"Discover",
"systems",
"using",
"WS",
"-",
"Discovery"
] | andreikop/python-ws-discovery | python | https://github.com/andreikop/python-ws-discovery/blob/a7b852cf43115c6f986e509b1870d6963e76687f/wsdiscovery/cmdline.py#L64-L74 | [
"def",
"discover",
"(",
"scope",
",",
"loglevel",
",",
"capture",
")",
":",
"if",
"loglevel",
":",
"level",
"=",
"getattr",
"(",
"logging",
",",
"loglevel",
",",
"None",
")",
"if",
"not",
"level",
":",
"print",
"(",
"\"Invalid log level '%s'\"",
"%",
"lo... | a7b852cf43115c6f986e509b1870d6963e76687f |
test | _ClusterTaggableManager.get_tagged_item_manager | Return the manager that handles the relation from this instance to the tagged_item class.
If content_object on the tagged_item class is defined as a ParentalKey, this will be a
DeferringRelatedManager which allows writing related objects without committing them
to the database. | modelcluster/contrib/taggit.py | def get_tagged_item_manager(self):
"""Return the manager that handles the relation from this instance to the tagged_item class.
If content_object on the tagged_item class is defined as a ParentalKey, this will be a
DeferringRelatedManager which allows writing related objects without committing t... | def get_tagged_item_manager(self):
"""Return the manager that handles the relation from this instance to the tagged_item class.
If content_object on the tagged_item class is defined as a ParentalKey, this will be a
DeferringRelatedManager which allows writing related objects without committing t... | [
"Return",
"the",
"manager",
"that",
"handles",
"the",
"relation",
"from",
"this",
"instance",
"to",
"the",
"tagged_item",
"class",
".",
"If",
"content_object",
"on",
"the",
"tagged_item",
"class",
"is",
"defined",
"as",
"a",
"ParentalKey",
"this",
"will",
"be"... | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/contrib/taggit.py#L17-L24 | [
"def",
"get_tagged_item_manager",
"(",
"self",
")",
":",
"rel_name",
"=",
"self",
".",
"through",
".",
"_meta",
".",
"get_field",
"(",
"'content_object'",
")",
".",
"remote_field",
".",
"get_accessor_name",
"(",
")",
"return",
"getattr",
"(",
"self",
".",
"i... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | get_serializable_data_for_fields | Return a serialised version of the model's fields which exist as local database
columns (i.e. excluding m2m and incoming foreign key relations) | modelcluster/models.py | def get_serializable_data_for_fields(model):
"""
Return a serialised version of the model's fields which exist as local database
columns (i.e. excluding m2m and incoming foreign key relations)
"""
pk_field = model._meta.pk
# If model is a child via multitable inheritance, use parent's pk
whi... | def get_serializable_data_for_fields(model):
"""
Return a serialised version of the model's fields which exist as local database
columns (i.e. excluding m2m and incoming foreign key relations)
"""
pk_field = model._meta.pk
# If model is a child via multitable inheritance, use parent's pk
whi... | [
"Return",
"a",
"serialised",
"version",
"of",
"the",
"model",
"s",
"fields",
"which",
"exist",
"as",
"local",
"database",
"columns",
"(",
"i",
".",
"e",
".",
"excluding",
"m2m",
"and",
"incoming",
"foreign",
"key",
"relations",
")"
] | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/models.py#L38-L54 | [
"def",
"get_serializable_data_for_fields",
"(",
"model",
")",
":",
"pk_field",
"=",
"model",
".",
"_meta",
".",
"pk",
"# If model is a child via multitable inheritance, use parent's pk",
"while",
"pk_field",
".",
"remote_field",
"and",
"pk_field",
".",
"remote_field",
"."... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | get_all_child_relations | Return a list of RelatedObject records for child relations of the given model,
including ones attached to ancestors of the model | modelcluster/models.py | def get_all_child_relations(model):
"""
Return a list of RelatedObject records for child relations of the given model,
including ones attached to ancestors of the model
"""
return [
field for field in model._meta.get_fields()
if isinstance(field.remote_field, ParentalKey)
] | def get_all_child_relations(model):
"""
Return a list of RelatedObject records for child relations of the given model,
including ones attached to ancestors of the model
"""
return [
field for field in model._meta.get_fields()
if isinstance(field.remote_field, ParentalKey)
] | [
"Return",
"a",
"list",
"of",
"RelatedObject",
"records",
"for",
"child",
"relations",
"of",
"the",
"given",
"model",
"including",
"ones",
"attached",
"to",
"ancestors",
"of",
"the",
"model"
] | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/models.py#L124-L132 | [
"def",
"get_all_child_relations",
"(",
"model",
")",
":",
"return",
"[",
"field",
"for",
"field",
"in",
"model",
".",
"_meta",
".",
"get_fields",
"(",
")",
"if",
"isinstance",
"(",
"field",
".",
"remote_field",
",",
"ParentalKey",
")",
"]"
] | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | get_all_child_m2m_relations | Return a list of ParentalManyToManyFields on the given model,
including ones attached to ancestors of the model | modelcluster/models.py | def get_all_child_m2m_relations(model):
"""
Return a list of ParentalManyToManyFields on the given model,
including ones attached to ancestors of the model
"""
return [
field for field in model._meta.get_fields()
if isinstance(field, ParentalManyToManyField)
] | def get_all_child_m2m_relations(model):
"""
Return a list of ParentalManyToManyFields on the given model,
including ones attached to ancestors of the model
"""
return [
field for field in model._meta.get_fields()
if isinstance(field, ParentalManyToManyField)
] | [
"Return",
"a",
"list",
"of",
"ParentalManyToManyFields",
"on",
"the",
"given",
"model",
"including",
"ones",
"attached",
"to",
"ancestors",
"of",
"the",
"model"
] | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/models.py#L135-L143 | [
"def",
"get_all_child_m2m_relations",
"(",
"model",
")",
":",
"return",
"[",
"field",
"for",
"field",
"in",
"model",
".",
"_meta",
".",
"get_fields",
"(",
")",
"if",
"isinstance",
"(",
"field",
",",
"ParentalManyToManyField",
")",
"]"
] | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | ClusterableModel.save | Save the model and commit all child relations. | modelcluster/models.py | def save(self, **kwargs):
"""
Save the model and commit all child relations.
"""
child_relation_names = [rel.get_accessor_name() for rel in get_all_child_relations(self)]
child_m2m_field_names = [field.name for field in get_all_child_m2m_relations(self)]
update_fields = ... | def save(self, **kwargs):
"""
Save the model and commit all child relations.
"""
child_relation_names = [rel.get_accessor_name() for rel in get_all_child_relations(self)]
child_m2m_field_names = [field.name for field in get_all_child_m2m_relations(self)]
update_fields = ... | [
"Save",
"the",
"model",
"and",
"commit",
"all",
"child",
"relations",
"."
] | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/models.py#L172-L202 | [
"def",
"save",
"(",
"self",
",",
"*",
"*",
"kwargs",
")",
":",
"child_relation_names",
"=",
"[",
"rel",
".",
"get_accessor_name",
"(",
")",
"for",
"rel",
"in",
"get_all_child_relations",
"(",
"self",
")",
"]",
"child_m2m_field_names",
"=",
"[",
"field",
".... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | ClusterableModel.from_serializable_data | Build an instance of this model from the JSON-like structure passed in,
recursing into related objects as required.
If check_fks is true, it will check whether referenced foreign keys still
exist in the database.
- dangling foreign keys on related objects are dealt with by either nullify... | modelcluster/models.py | def from_serializable_data(cls, data, check_fks=True, strict_fks=False):
"""
Build an instance of this model from the JSON-like structure passed in,
recursing into related objects as required.
If check_fks is true, it will check whether referenced foreign keys still
exist in the ... | def from_serializable_data(cls, data, check_fks=True, strict_fks=False):
"""
Build an instance of this model from the JSON-like structure passed in,
recursing into related objects as required.
If check_fks is true, it will check whether referenced foreign keys still
exist in the ... | [
"Build",
"an",
"instance",
"of",
"this",
"model",
"from",
"the",
"JSON",
"-",
"like",
"structure",
"passed",
"in",
"recursing",
"into",
"related",
"objects",
"as",
"required",
".",
"If",
"check_fks",
"is",
"true",
"it",
"will",
"check",
"whether",
"reference... | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/models.py#L227-L268 | [
"def",
"from_serializable_data",
"(",
"cls",
",",
"data",
",",
"check_fks",
"=",
"True",
",",
"strict_fks",
"=",
"False",
")",
":",
"obj",
"=",
"model_from_serializable_data",
"(",
"cls",
",",
"data",
",",
"check_fks",
"=",
"check_fks",
",",
"strict_fks",
"=... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | BaseChildFormSet.validate_unique | This clean method will check for unique_together condition | modelcluster/forms.py | def validate_unique(self):
'''This clean method will check for unique_together condition'''
# Collect unique_checks and to run from all the forms.
all_unique_checks = set()
all_date_checks = set()
forms_to_delete = self.deleted_forms
valid_forms = [form for form in self.f... | def validate_unique(self):
'''This clean method will check for unique_together condition'''
# Collect unique_checks and to run from all the forms.
all_unique_checks = set()
all_date_checks = set()
forms_to_delete = self.deleted_forms
valid_forms = [form for form in self.f... | [
"This",
"clean",
"method",
"will",
"check",
"for",
"unique_together",
"condition"
] | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/forms.py#L125-L165 | [
"def",
"validate_unique",
"(",
"self",
")",
":",
"# Collect unique_checks and to run from all the forms.",
"all_unique_checks",
"=",
"set",
"(",
")",
"all_date_checks",
"=",
"set",
"(",
")",
"forms_to_delete",
"=",
"self",
".",
"deleted_forms",
"valid_forms",
"=",
"["... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | ClusterForm.has_changed | Return True if data differs from initial. | modelcluster/forms.py | def has_changed(self):
"""Return True if data differs from initial."""
# Need to recurse over nested formsets so that the form is saved if there are changes
# to child forms but not the parent
if self.formsets:
for formset in self.formsets.values():
for form ... | def has_changed(self):
"""Return True if data differs from initial."""
# Need to recurse over nested formsets so that the form is saved if there are changes
# to child forms but not the parent
if self.formsets:
for formset in self.formsets.values():
for form ... | [
"Return",
"True",
"if",
"data",
"differs",
"from",
"initial",
"."
] | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/forms.py#L361-L371 | [
"def",
"has_changed",
"(",
"self",
")",
":",
"# Need to recurse over nested formsets so that the form is saved if there are changes",
"# to child forms but not the parent",
"if",
"self",
".",
"formsets",
":",
"for",
"formset",
"in",
"self",
".",
"formsets",
".",
"values",
"... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | create_deferring_foreign_related_manager | Create a DeferringRelatedManager class that wraps an ordinary RelatedManager
with 'deferring' behaviour: any updates to the object set (via e.g. add() or clear())
are written to a holding area rather than committed to the database immediately.
Writing to the database is deferred until the model is saved. | modelcluster/fields.py | def create_deferring_foreign_related_manager(related, original_manager_cls):
"""
Create a DeferringRelatedManager class that wraps an ordinary RelatedManager
with 'deferring' behaviour: any updates to the object set (via e.g. add() or clear())
are written to a holding area rather than committed to the d... | def create_deferring_foreign_related_manager(related, original_manager_cls):
"""
Create a DeferringRelatedManager class that wraps an ordinary RelatedManager
with 'deferring' behaviour: any updates to the object set (via e.g. add() or clear())
are written to a holding area rather than committed to the d... | [
"Create",
"a",
"DeferringRelatedManager",
"class",
"that",
"wraps",
"an",
"ordinary",
"RelatedManager",
"with",
"deferring",
"behaviour",
":",
"any",
"updates",
"to",
"the",
"object",
"set",
"(",
"via",
"e",
".",
"g",
".",
"add",
"()",
"or",
"clear",
"()",
... | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/fields.py#L17-L212 | [
"def",
"create_deferring_foreign_related_manager",
"(",
"related",
",",
"original_manager_cls",
")",
":",
"relation_name",
"=",
"related",
".",
"get_accessor_name",
"(",
")",
"rel_field",
"=",
"related",
".",
"field",
"rel_model",
"=",
"related",
".",
"related_model",... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | sort_by_fields | Sort a list of objects on the given fields. The field list works analogously to
queryset.order_by(*fields): each field is either a property of the object,
or is prefixed by '-' (e.g. '-name') to indicate reverse ordering. | modelcluster/utils.py | def sort_by_fields(items, fields):
"""
Sort a list of objects on the given fields. The field list works analogously to
queryset.order_by(*fields): each field is either a property of the object,
or is prefixed by '-' (e.g. '-name') to indicate reverse ordering.
"""
# To get the desired behaviour,... | def sort_by_fields(items, fields):
"""
Sort a list of objects on the given fields. The field list works analogously to
queryset.order_by(*fields): each field is either a property of the object,
or is prefixed by '-' (e.g. '-name') to indicate reverse ordering.
"""
# To get the desired behaviour,... | [
"Sort",
"a",
"list",
"of",
"objects",
"on",
"the",
"given",
"fields",
".",
"The",
"field",
"list",
"works",
"analogously",
"to",
"queryset",
".",
"order_by",
"(",
"*",
"fields",
")",
":",
"each",
"field",
"is",
"either",
"a",
"property",
"of",
"the",
"... | wagtail/django-modelcluster | python | https://github.com/wagtail/django-modelcluster/blob/bfc8bd755af0ddd49e2aee2f2ca126921573d38b/modelcluster/utils.py#L1-L19 | [
"def",
"sort_by_fields",
"(",
"items",
",",
"fields",
")",
":",
"# To get the desired behaviour, we need to order by keys in reverse order",
"# See: https://docs.python.org/2/howto/sorting.html#sort-stability-and-complex-sorts",
"for",
"key",
"in",
"reversed",
"(",
"fields",
")",
"... | bfc8bd755af0ddd49e2aee2f2ca126921573d38b |
test | Address.with_valid_checksum | Returns the address with a valid checksum attached. | iota/types.py | def with_valid_checksum(self):
# type: () -> Address
"""
Returns the address with a valid checksum attached.
"""
return Address(
trytes=self.address + self._generate_checksum(),
# Make sure to copy all of the ancillary attributes, too!
balance... | def with_valid_checksum(self):
# type: () -> Address
"""
Returns the address with a valid checksum attached.
"""
return Address(
trytes=self.address + self._generate_checksum(),
# Make sure to copy all of the ancillary attributes, too!
balance... | [
"Returns",
"the",
"address",
"with",
"a",
"valid",
"checksum",
"attached",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/types.py#L844-L856 | [
"def",
"with_valid_checksum",
"(",
"self",
")",
":",
"# type: () -> Address",
"return",
"Address",
"(",
"trytes",
"=",
"self",
".",
"address",
"+",
"self",
".",
"_generate_checksum",
"(",
")",
",",
"# Make sure to copy all of the ancillary attributes, too!",
"balance",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Address._generate_checksum | Generates the correct checksum for this address. | iota/types.py | def _generate_checksum(self):
# type: () -> AddressChecksum
"""
Generates the correct checksum for this address.
"""
checksum_trits = [] # type: MutableSequence[int]
sponge = Kerl()
sponge.absorb(self.address.as_trits())
sponge.squeeze(checksum_trits)
... | def _generate_checksum(self):
# type: () -> AddressChecksum
"""
Generates the correct checksum for this address.
"""
checksum_trits = [] # type: MutableSequence[int]
sponge = Kerl()
sponge.absorb(self.address.as_trits())
sponge.squeeze(checksum_trits)
... | [
"Generates",
"the",
"correct",
"checksum",
"for",
"this",
"address",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/types.py#L858-L871 | [
"def",
"_generate_checksum",
"(",
"self",
")",
":",
"# type: () -> AddressChecksum",
"checksum_trits",
"=",
"[",
"]",
"# type: MutableSequence[int]",
"sponge",
"=",
"Kerl",
"(",
")",
"sponge",
".",
"absorb",
"(",
"self",
".",
"address",
".",
"as_trits",
"(",
")"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | IotaCommandLineApp.execute | Executes the command and (optionally) returns an exit code (used by
the shell to determine if the application exited cleanly).
:param api:
The API object used to communicate with the node.
:param arguments:
Command-line arguments parsed by the argument parser. | iota/bin/__init__.py | def execute(self, api, **arguments):
# type: (Iota, **Any) -> Optional[int]
"""
Executes the command and (optionally) returns an exit code (used by
the shell to determine if the application exited cleanly).
:param api:
The API object used to communicate with the node... | def execute(self, api, **arguments):
# type: (Iota, **Any) -> Optional[int]
"""
Executes the command and (optionally) returns an exit code (used by
the shell to determine if the application exited cleanly).
:param api:
The API object used to communicate with the node... | [
"Executes",
"the",
"command",
"and",
"(",
"optionally",
")",
"returns",
"an",
"exit",
"code",
"(",
"used",
"by",
"the",
"shell",
"to",
"determine",
"if",
"the",
"application",
"exited",
"cleanly",
")",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/bin/__init__.py#L41-L55 | [
"def",
"execute",
"(",
"self",
",",
"api",
",",
"*",
"*",
"arguments",
")",
":",
"# type: (Iota, **Any) -> Optional[int]",
"raise",
"NotImplementedError",
"(",
"'Not implemented in {cls}.'",
".",
"format",
"(",
"cls",
"=",
"type",
"(",
"self",
")",
".",
"__name_... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | IotaCommandLineApp.run_from_argv | Executes the command from a collection of arguments (e.g.,
:py:data`sys.argv`) and returns the exit code.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``. | iota/bin/__init__.py | def run_from_argv(self, argv=None):
# type: (Optional[tuple]) -> int
"""
Executes the command from a collection of arguments (e.g.,
:py:data`sys.argv`) and returns the exit code.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults... | def run_from_argv(self, argv=None):
# type: (Optional[tuple]) -> int
"""
Executes the command from a collection of arguments (e.g.,
:py:data`sys.argv`) and returns the exit code.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults... | [
"Executes",
"the",
"command",
"from",
"a",
"collection",
"of",
"arguments",
"(",
"e",
".",
"g",
".",
":",
"py",
":",
"data",
"sys",
".",
"argv",
")",
"and",
"returns",
"the",
"exit",
"code",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/bin/__init__.py#L63-L78 | [
"def",
"run_from_argv",
"(",
"self",
",",
"argv",
"=",
"None",
")",
":",
"# type: (Optional[tuple]) -> int",
"exit_code",
"=",
"self",
".",
"execute",
"(",
"*",
"*",
"self",
".",
"parse_argv",
"(",
"argv",
")",
")",
"if",
"exit_code",
"is",
"None",
":",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | IotaCommandLineApp.parse_argv | Parses arguments for the command.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``. | iota/bin/__init__.py | def parse_argv(self, argv=None):
# type: (Optional[tuple]) -> dict
"""
Parses arguments for the command.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``.
"""
arguments = vars(self.create_argument_pa... | def parse_argv(self, argv=None):
# type: (Optional[tuple]) -> dict
"""
Parses arguments for the command.
:param argv:
Arguments to pass to the argument parser.
If ``None``, defaults to ``sys.argv[1:]``.
"""
arguments = vars(self.create_argument_pa... | [
"Parses",
"arguments",
"for",
"the",
"command",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/bin/__init__.py#L80-L107 | [
"def",
"parse_argv",
"(",
"self",
",",
"argv",
"=",
"None",
")",
":",
"# type: (Optional[tuple]) -> dict",
"arguments",
"=",
"vars",
"(",
"self",
".",
"create_argument_parser",
"(",
")",
".",
"parse_args",
"(",
"argv",
")",
")",
"seed",
"=",
"None",
"if",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | IotaCommandLineApp.create_argument_parser | Returns the argument parser that will be used to interpret
arguments and options from argv. | iota/bin/__init__.py | def create_argument_parser(self):
# type: () -> ArgumentParser
"""
Returns the argument parser that will be used to interpret
arguments and options from argv.
"""
parser = ArgumentParser(
description=self.__doc__,
epilog='PyOTA v{version}'.format(v... | def create_argument_parser(self):
# type: () -> ArgumentParser
"""
Returns the argument parser that will be used to interpret
arguments and options from argv.
"""
parser = ArgumentParser(
description=self.__doc__,
epilog='PyOTA v{version}'.format(v... | [
"Returns",
"the",
"argument",
"parser",
"that",
"will",
"be",
"used",
"to",
"interpret",
"arguments",
"and",
"options",
"from",
"argv",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/bin/__init__.py#L109-L151 | [
"def",
"create_argument_parser",
"(",
"self",
")",
":",
"# type: () -> ArgumentParser",
"parser",
"=",
"ArgumentParser",
"(",
"description",
"=",
"self",
".",
"__doc__",
",",
"epilog",
"=",
"'PyOTA v{version}'",
".",
"format",
"(",
"version",
"=",
"__version__",
"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | IotaCommandLineApp.prompt_for_seed | Prompts the user to enter their seed via stdin. | iota/bin/__init__.py | def prompt_for_seed():
# type: () -> Seed
"""
Prompts the user to enter their seed via stdin.
"""
seed = secure_input(
'Enter seed and press return (typing will not be shown).\n'
'If no seed is specified, a random one will be used instead.\n'
)
... | def prompt_for_seed():
# type: () -> Seed
"""
Prompts the user to enter their seed via stdin.
"""
seed = secure_input(
'Enter seed and press return (typing will not be shown).\n'
'If no seed is specified, a random one will be used instead.\n'
)
... | [
"Prompts",
"the",
"user",
"to",
"enter",
"their",
"seed",
"via",
"stdin",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/bin/__init__.py#L165-L178 | [
"def",
"prompt_for_seed",
"(",
")",
":",
"# type: () -> Seed",
"seed",
"=",
"secure_input",
"(",
"'Enter seed and press return (typing will not be shown).\\n'",
"'If no seed is specified, a random one will be used instead.\\n'",
")",
"if",
"isinstance",
"(",
"seed",
",",
"text_ty... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | normalize | "Normalizes" a hash, converting it into a sequence of integers
(not trits!) suitable for use in signature generation/validation.
The hash is divided up into 3 parts, each of which is "balanced"
(sum of all the values is equal to zero). | iota/crypto/signing.py | def normalize(hash_):
# type: (Hash) -> List[List[int]]
"""
"Normalizes" a hash, converting it into a sequence of integers
(not trits!) suitable for use in signature generation/validation.
The hash is divided up into 3 parts, each of which is "balanced"
(sum of all the values is equal to zero).... | def normalize(hash_):
# type: (Hash) -> List[List[int]]
"""
"Normalizes" a hash, converting it into a sequence of integers
(not trits!) suitable for use in signature generation/validation.
The hash is divided up into 3 parts, each of which is "balanced"
(sum of all the values is equal to zero).... | [
"Normalizes",
"a",
"hash",
"converting",
"it",
"into",
"a",
"sequence",
"of",
"integers",
"(",
"not",
"trits!",
")",
"suitable",
"for",
"use",
"in",
"signature",
"generation",
"/",
"validation",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/signing.py#L25-L62 | [
"def",
"normalize",
"(",
"hash_",
")",
":",
"# type: (Hash) -> List[List[int]]",
"normalized",
"=",
"[",
"]",
"source",
"=",
"hash_",
".",
"as_integers",
"(",
")",
"chunk_size",
"=",
"27",
"for",
"i",
"in",
"range",
"(",
"Hash",
".",
"LEN",
"//",
"chunk_si... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | validate_signature_fragments | Returns whether a sequence of signature fragments is valid.
:param fragments:
Sequence of signature fragments (usually
:py:class:`iota.transaction.Fragment` instances).
:param hash_:
Hash used to generate the signature fragments (usually a
:py:class:`iota.transaction.BundleHash` instan... | iota/crypto/signing.py | def validate_signature_fragments(
fragments,
hash_,
public_key,
sponge_type=Kerl,
):
# type: (Sequence[TryteString], Hash, TryteString, type) -> bool
"""
Returns whether a sequence of signature fragments is valid.
:param fragments:
Sequence of signature fragments (... | def validate_signature_fragments(
fragments,
hash_,
public_key,
sponge_type=Kerl,
):
# type: (Sequence[TryteString], Hash, TryteString, type) -> bool
"""
Returns whether a sequence of signature fragments is valid.
:param fragments:
Sequence of signature fragments (... | [
"Returns",
"whether",
"a",
"sequence",
"of",
"signature",
"fragments",
"is",
"valid",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/signing.py#L403-L460 | [
"def",
"validate_signature_fragments",
"(",
"fragments",
",",
"hash_",
",",
"public_key",
",",
"sponge_type",
"=",
"Kerl",
",",
")",
":",
"# type: (Sequence[TryteString], Hash, TryteString, type) -> bool",
"checksum",
"=",
"[",
"0",
"]",
"*",
"(",
"HASH_LENGTH",
"*",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | KeyGenerator.get_key | Generates a single key.
:param index:
The key index.
:param iterations:
Number of transform iterations to apply to the key, also
known as security level.
Must be >= 1.
Increasing this value makes key generation slower, but more
r... | iota/crypto/signing.py | def get_key(self, index, iterations):
# type: (int, int) -> PrivateKey
"""
Generates a single key.
:param index:
The key index.
:param iterations:
Number of transform iterations to apply to the key, also
known as security level.
M... | def get_key(self, index, iterations):
# type: (int, int) -> PrivateKey
"""
Generates a single key.
:param index:
The key index.
:param iterations:
Number of transform iterations to apply to the key, also
known as security level.
M... | [
"Generates",
"a",
"single",
"key",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/signing.py#L76-L99 | [
"def",
"get_key",
"(",
"self",
",",
"index",
",",
"iterations",
")",
":",
"# type: (int, int) -> PrivateKey",
"return",
"(",
"self",
".",
"get_keys",
"(",
"start",
"=",
"index",
",",
"count",
"=",
"1",
",",
"step",
"=",
"1",
",",
"iterations",
"=",
"iter... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | KeyGenerator.get_key_for | Generates the key associated with the specified address.
Note that this method will generate the wrong key if the input
address was generated from a different key! | iota/crypto/signing.py | def get_key_for(self, address):
"""
Generates the key associated with the specified address.
Note that this method will generate the wrong key if the input
address was generated from a different key!
"""
return self.get_key(
index=address.key_index,
... | def get_key_for(self, address):
"""
Generates the key associated with the specified address.
Note that this method will generate the wrong key if the input
address was generated from a different key!
"""
return self.get_key(
index=address.key_index,
... | [
"Generates",
"the",
"key",
"associated",
"with",
"the",
"specified",
"address",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/signing.py#L101-L111 | [
"def",
"get_key_for",
"(",
"self",
",",
"address",
")",
":",
"return",
"self",
".",
"get_key",
"(",
"index",
"=",
"address",
".",
"key_index",
",",
"iterations",
"=",
"address",
".",
"security_level",
",",
")"
] | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | KeyGenerator.get_keys | Generates and returns one or more keys at the specified
index(es).
This is a one-time operation; if you want to create lots of keys
across multiple contexts, consider invoking
:py:meth:`create_iterator` and sharing the resulting generator
object instead.
Warning: This m... | iota/crypto/signing.py | def get_keys(self, start, count=1, step=1, iterations=1):
# type: (int, int, int, int) -> List[PrivateKey]
"""
Generates and returns one or more keys at the specified
index(es).
This is a one-time operation; if you want to create lots of keys
across multiple contexts, co... | def get_keys(self, start, count=1, step=1, iterations=1):
# type: (int, int, int, int) -> List[PrivateKey]
"""
Generates and returns one or more keys at the specified
index(es).
This is a one-time operation; if you want to create lots of keys
across multiple contexts, co... | [
"Generates",
"and",
"returns",
"one",
"or",
"more",
"keys",
"at",
"the",
"specified",
"index",
"(",
"es",
")",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/signing.py#L113-L189 | [
"def",
"get_keys",
"(",
"self",
",",
"start",
",",
"count",
"=",
"1",
",",
"step",
"=",
"1",
",",
"iterations",
"=",
"1",
")",
":",
"# type: (int, int, int, int) -> List[PrivateKey]",
"if",
"count",
"<",
"1",
":",
"raise",
"with_context",
"(",
"exc",
"=",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | KeyGenerator.create_iterator | Creates a generator that can be used to progressively generate
new keys.
:param start:
Starting index.
Warning: This method may take awhile to reset if ``start``
is a large number!
:param step:
Number of indexes to advance after each key.
... | iota/crypto/signing.py | def create_iterator(self, start=0, step=1, security_level=1):
# type: (int, int, int) -> KeyIterator
"""
Creates a generator that can be used to progressively generate
new keys.
:param start:
Starting index.
Warning: This method may take awhile to reset ... | def create_iterator(self, start=0, step=1, security_level=1):
# type: (int, int, int) -> KeyIterator
"""
Creates a generator that can be used to progressively generate
new keys.
:param start:
Starting index.
Warning: This method may take awhile to reset ... | [
"Creates",
"a",
"generator",
"that",
"can",
"be",
"used",
"to",
"progressively",
"generate",
"new",
"keys",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/signing.py#L191-L219 | [
"def",
"create_iterator",
"(",
"self",
",",
"start",
"=",
"0",
",",
"step",
"=",
"1",
",",
"security_level",
"=",
"1",
")",
":",
"# type: (int, int, int) -> KeyIterator",
"return",
"KeyIterator",
"(",
"self",
".",
"seed",
",",
"start",
",",
"step",
",",
"s... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | KeyIterator._create_sponge | Prepares the hash sponge for the generator. | iota/crypto/signing.py | def _create_sponge(self, index):
# type: (int) -> Kerl
"""
Prepares the hash sponge for the generator.
"""
seed = self.seed_as_trits[:]
sponge = Kerl()
sponge.absorb(add_trits(seed, trits_from_int(index)))
# Squeeze all of the trits out of the sponge and... | def _create_sponge(self, index):
# type: (int) -> Kerl
"""
Prepares the hash sponge for the generator.
"""
seed = self.seed_as_trits[:]
sponge = Kerl()
sponge.absorb(add_trits(seed, trits_from_int(index)))
# Squeeze all of the trits out of the sponge and... | [
"Prepares",
"the",
"hash",
"sponge",
"for",
"the",
"generator",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/signing.py#L316-L334 | [
"def",
"_create_sponge",
"(",
"self",
",",
"index",
")",
":",
"# type: (int) -> Kerl",
"seed",
"=",
"self",
".",
"seed_as_trits",
"[",
":",
"]",
"sponge",
"=",
"Kerl",
"(",
")",
"sponge",
".",
"absorb",
"(",
"add_trits",
"(",
"seed",
",",
"trits_from_int",... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Curl.absorb | Absorb trits into the sponge.
:param trits:
Sequence of trits to absorb.
:param offset:
Starting offset in ``trits``.
:param length:
Number of trits to absorb. Defaults to ``len(trits)``. | iota/crypto/pycurl.py | def absorb(self, trits, offset=0, length=None):
# type: (Sequence[int], Optional[int], Optional[int]) -> None
"""
Absorb trits into the sponge.
:param trits:
Sequence of trits to absorb.
:param offset:
Starting offset in ``trits``.
:param length... | def absorb(self, trits, offset=0, length=None):
# type: (Sequence[int], Optional[int], Optional[int]) -> None
"""
Absorb trits into the sponge.
:param trits:
Sequence of trits to absorb.
:param offset:
Starting offset in ``trits``.
:param length... | [
"Absorb",
"trits",
"into",
"the",
"sponge",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/pycurl.py#L64-L113 | [
"def",
"absorb",
"(",
"self",
",",
"trits",
",",
"offset",
"=",
"0",
",",
"length",
"=",
"None",
")",
":",
"# type: (Sequence[int], Optional[int], Optional[int]) -> None",
"pad",
"=",
"(",
"(",
"len",
"(",
"trits",
")",
"%",
"HASH_LENGTH",
")",
"or",
"HASH_L... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Curl.squeeze | Squeeze trits from the sponge.
:param trits:
Sequence that the squeezed trits will be copied to.
Note: this object will be modified!
:param offset:
Starting offset in ``trits``.
:param length:
Number of trits to squeeze, default to ``HASH_LENGTH... | iota/crypto/pycurl.py | def squeeze(self, trits, offset=0, length=HASH_LENGTH):
# type: (MutableSequence[int], Optional[int], Optional[int]) -> None
"""
Squeeze trits from the sponge.
:param trits:
Sequence that the squeezed trits will be copied to.
Note: this object will be modified!
... | def squeeze(self, trits, offset=0, length=HASH_LENGTH):
# type: (MutableSequence[int], Optional[int], Optional[int]) -> None
"""
Squeeze trits from the sponge.
:param trits:
Sequence that the squeezed trits will be copied to.
Note: this object will be modified!
... | [
"Squeeze",
"trits",
"from",
"the",
"sponge",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/pycurl.py#L115-L172 | [
"def",
"squeeze",
"(",
"self",
",",
"trits",
",",
"offset",
"=",
"0",
",",
"length",
"=",
"HASH_LENGTH",
")",
":",
"# type: (MutableSequence[int], Optional[int], Optional[int]) -> None",
"# Squeeze is kind of like the opposite of absorb; it copies",
"# trits from internal state t... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Curl._transform | Transforms internal state. | iota/crypto/pycurl.py | def _transform(self):
# type: () -> None
"""
Transforms internal state.
"""
# Copy some values locally so we can avoid global lookups in the
# inner loop.
#
# References:
#
# - https://wiki.python.org/moin/PythonSpeed/PerformanceTips#Local_... | def _transform(self):
# type: () -> None
"""
Transforms internal state.
"""
# Copy some values locally so we can avoid global lookups in the
# inner loop.
#
# References:
#
# - https://wiki.python.org/moin/PythonSpeed/PerformanceTips#Local_... | [
"Transforms",
"internal",
"state",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/pycurl.py#L174-L218 | [
"def",
"_transform",
"(",
"self",
")",
":",
"# type: () -> None",
"# Copy some values locally so we can avoid global lookups in the",
"# inner loop.",
"#",
"# References:",
"#",
"# - https://wiki.python.org/moin/PythonSpeed/PerformanceTips#Local_Variables",
"state_length",
"=",
"STATE_... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | MultisigIota.get_digests | Generates one or more key digests from the seed.
Digests are safe to share; use them to generate multisig
addresses.
:param index:
The starting key index.
:param count:
Number of digests to generate.
:param security_level:
Number of iterati... | iota/multisig/api.py | def get_digests(
self,
index=0,
count=1,
security_level=AddressGenerator.DEFAULT_SECURITY_LEVEL,
):
# type: (int, int, int) -> dict
"""
Generates one or more key digests from the seed.
Digests are safe to share; use them to generate mu... | def get_digests(
self,
index=0,
count=1,
security_level=AddressGenerator.DEFAULT_SECURITY_LEVEL,
):
# type: (int, int, int) -> dict
"""
Generates one or more key digests from the seed.
Digests are safe to share; use them to generate mu... | [
"Generates",
"one",
"or",
"more",
"key",
"digests",
"from",
"the",
"seed",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/multisig/api.py#L61-L102 | [
"def",
"get_digests",
"(",
"self",
",",
"index",
"=",
"0",
",",
"count",
"=",
"1",
",",
"security_level",
"=",
"AddressGenerator",
".",
"DEFAULT_SECURITY_LEVEL",
",",
")",
":",
"# type: (int, int, int) -> dict",
"return",
"commands",
".",
"GetDigestsCommand",
"(",... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | MultisigIota.get_private_keys | Generates one or more private keys from the seed.
As the name implies, private keys should not be shared.
However, in a few cases it may be necessary (e.g., for M-of-N
transactions).
:param index:
The starting key index.
:param count:
Number of keys to ... | iota/multisig/api.py | def get_private_keys(
self,
index=0,
count=1,
security_level=AddressGenerator.DEFAULT_SECURITY_LEVEL,
):
# type: (int, int, int) -> dict
"""
Generates one or more private keys from the seed.
As the name implies, private keys should not... | def get_private_keys(
self,
index=0,
count=1,
security_level=AddressGenerator.DEFAULT_SECURITY_LEVEL,
):
# type: (int, int, int) -> dict
"""
Generates one or more private keys from the seed.
As the name implies, private keys should not... | [
"Generates",
"one",
"or",
"more",
"private",
"keys",
"from",
"the",
"seed",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/multisig/api.py#L104-L151 | [
"def",
"get_private_keys",
"(",
"self",
",",
"index",
"=",
"0",
",",
"count",
"=",
"1",
",",
"security_level",
"=",
"AddressGenerator",
".",
"DEFAULT_SECURITY_LEVEL",
",",
")",
":",
"# type: (int, int, int) -> dict",
"return",
"commands",
".",
"GetPrivateKeysCommand... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | MultisigIota.prepare_multisig_transfer | Prepares a bundle that authorizes the spending of IOTAs from a
multisig address.
.. note::
This method is used exclusively to spend IOTAs from a
multisig address.
If you want to spend IOTAs from non-multisig addresses, or
if you want to create 0-value tr... | iota/multisig/api.py | def prepare_multisig_transfer(
self,
transfers, # type: Iterable[ProposedTransaction]
multisig_input, # type: MultisigAddress
change_address=None, # type: Optional[Address]
):
# type: (...) -> dict
"""
Prepares a bundle that authorizes the s... | def prepare_multisig_transfer(
self,
transfers, # type: Iterable[ProposedTransaction]
multisig_input, # type: MultisigAddress
change_address=None, # type: Optional[Address]
):
# type: (...) -> dict
"""
Prepares a bundle that authorizes the s... | [
"Prepares",
"a",
"bundle",
"that",
"authorizes",
"the",
"spending",
"of",
"IOTAs",
"from",
"a",
"multisig",
"address",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/multisig/api.py#L153-L243 | [
"def",
"prepare_multisig_transfer",
"(",
"self",
",",
"transfers",
",",
"# type: Iterable[ProposedTransaction]",
"multisig_input",
",",
"# type: MultisigAddress",
"change_address",
"=",
"None",
",",
"# type: Optional[Address]",
")",
":",
"# type: (...) -> dict",
"return",
"co... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | add_trits | Adds two sequences of trits together.
The result is a list of trits equal in length to the longer of the
two sequences.
.. note::
Overflow is possible.
For example, ``add_trits([1], [1])`` returns ``[-1]``. | iota/trits.py | def add_trits(left, right):
# type: (Sequence[int], Sequence[int]) -> List[int]
"""
Adds two sequences of trits together.
The result is a list of trits equal in length to the longer of the
two sequences.
.. note::
Overflow is possible.
For example, ``add_trits([1], [1])`` retu... | def add_trits(left, right):
# type: (Sequence[int], Sequence[int]) -> List[int]
"""
Adds two sequences of trits together.
The result is a list of trits equal in length to the longer of the
two sequences.
.. note::
Overflow is possible.
For example, ``add_trits([1], [1])`` retu... | [
"Adds",
"two",
"sequences",
"of",
"trits",
"together",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/trits.py#L21-L44 | [
"def",
"add_trits",
"(",
"left",
",",
"right",
")",
":",
"# type: (Sequence[int], Sequence[int]) -> List[int]",
"target_len",
"=",
"max",
"(",
"len",
"(",
"left",
")",
",",
"len",
"(",
"right",
")",
")",
"res",
"=",
"[",
"0",
"]",
"*",
"target_len",
"left"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | trits_from_int | Returns a trit representation of an integer value.
:param n:
Integer value to convert.
:param pad:
Ensure the result has at least this many trits.
References:
- https://dev.to/buntine/the-balanced-ternary-machines-of-soviet-russia
- https://en.wikipedia.org/wiki/Balanced_ternary
... | iota/trits.py | def trits_from_int(n, pad=1):
# type: (int, Optional[int]) -> List[int]
"""
Returns a trit representation of an integer value.
:param n:
Integer value to convert.
:param pad:
Ensure the result has at least this many trits.
References:
- https://dev.to/buntine/the-balanced... | def trits_from_int(n, pad=1):
# type: (int, Optional[int]) -> List[int]
"""
Returns a trit representation of an integer value.
:param n:
Integer value to convert.
:param pad:
Ensure the result has at least this many trits.
References:
- https://dev.to/buntine/the-balanced... | [
"Returns",
"a",
"trit",
"representation",
"of",
"an",
"integer",
"value",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/trits.py#L57-L90 | [
"def",
"trits_from_int",
"(",
"n",
",",
"pad",
"=",
"1",
")",
":",
"# type: (int, Optional[int]) -> List[int]",
"if",
"n",
"==",
"0",
":",
"trits",
"=",
"[",
"]",
"else",
":",
"quotient",
",",
"remainder",
"=",
"divmod",
"(",
"n",
",",
"3",
")",
"if",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | _add_trits | Adds two individual trits together.
The result is always a single trit. | iota/trits.py | def _add_trits(left, right):
# type: (int, int) -> int
"""
Adds two individual trits together.
The result is always a single trit.
"""
res = left + right
return res if -2 < res < 2 else (res < 0) - (res > 0) | def _add_trits(left, right):
# type: (int, int) -> int
"""
Adds two individual trits together.
The result is always a single trit.
"""
res = left + right
return res if -2 < res < 2 else (res < 0) - (res > 0) | [
"Adds",
"two",
"individual",
"trits",
"together",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/trits.py#L102-L110 | [
"def",
"_add_trits",
"(",
"left",
",",
"right",
")",
":",
"# type: (int, int) -> int",
"res",
"=",
"left",
"+",
"right",
"return",
"res",
"if",
"-",
"2",
"<",
"res",
"<",
"2",
"else",
"(",
"res",
"<",
"0",
")",
"-",
"(",
"res",
">",
"0",
")"
] | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | _full_add_trits | Adds two trits together, with support for a carry trit. | iota/trits.py | def _full_add_trits(left, right, carry):
# type: (int, int, int) -> Tuple[int, int]
"""
Adds two trits together, with support for a carry trit.
"""
sum_both = _add_trits(left, right)
cons_left = _cons_trits(left, right)
cons_right = _cons_trits(sum_both, carry)
return _add_trits(sum_bot... | def _full_add_trits(left, right, carry):
# type: (int, int, int) -> Tuple[int, int]
"""
Adds two trits together, with support for a carry trit.
"""
sum_both = _add_trits(left, right)
cons_left = _cons_trits(left, right)
cons_right = _cons_trits(sum_both, carry)
return _add_trits(sum_bot... | [
"Adds",
"two",
"trits",
"together",
"with",
"support",
"for",
"a",
"carry",
"trit",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/trits.py#L123-L132 | [
"def",
"_full_add_trits",
"(",
"left",
",",
"right",
",",
"carry",
")",
":",
"# type: (int, int, int) -> Tuple[int, int]",
"sum_both",
"=",
"_add_trits",
"(",
"left",
",",
"right",
")",
"cons_left",
"=",
"_cons_trits",
"(",
"left",
",",
"right",
")",
"cons_right... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | output_seed | Outputs the user's seed to stdout, along with lots of warnings
about security. | examples/address_generator.py | def output_seed(seed):
# type: (Seed) -> None
"""
Outputs the user's seed to stdout, along with lots of warnings
about security.
"""
print(
'WARNING: Anyone who has your seed can spend your IOTAs! '
'Clear the screen after recording your seed!'
)
compat.input('')
prin... | def output_seed(seed):
# type: (Seed) -> None
"""
Outputs the user's seed to stdout, along with lots of warnings
about security.
"""
print(
'WARNING: Anyone who has your seed can spend your IOTAs! '
'Clear the screen after recording your seed!'
)
compat.input('')
prin... | [
"Outputs",
"the",
"user",
"s",
"seed",
"to",
"stdout",
"along",
"with",
"lots",
"of",
"warnings",
"about",
"security",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/examples/address_generator.py#L59-L80 | [
"def",
"output_seed",
"(",
"seed",
")",
":",
"# type: (Seed) -> None",
"print",
"(",
"'WARNING: Anyone who has your seed can spend your IOTAs! '",
"'Clear the screen after recording your seed!'",
")",
"compat",
".",
"input",
"(",
"''",
")",
"print",
"(",
"'Your seed is:'",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | StrictIota.attach_to_tangle | Attaches the specified transactions (trytes) to the Tangle by
doing Proof of Work. You need to supply branchTransaction as
well as trunkTransaction (basically the tips which you're going
to validate and reference with this transaction) - both of which
you'll get through the getTransactio... | iota/api.py | def attach_to_tangle(
self,
trunk_transaction, # type: TransactionHash
branch_transaction, # type: TransactionHash
trytes, # type: Iterable[TryteString]
min_weight_magnitude=None, # type: Optional[int]
):
# type: (...) -> dict
"""
... | def attach_to_tangle(
self,
trunk_transaction, # type: TransactionHash
branch_transaction, # type: TransactionHash
trytes, # type: Iterable[TryteString]
min_weight_magnitude=None, # type: Optional[int]
):
# type: (...) -> dict
"""
... | [
"Attaches",
"the",
"specified",
"transactions",
"(",
"trytes",
")",
"to",
"the",
"Tangle",
"by",
"doing",
"Proof",
"of",
"Work",
".",
"You",
"need",
"to",
"supply",
"branchTransaction",
"as",
"well",
"as",
"trunkTransaction",
"(",
"basically",
"the",
"tips",
... | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L171-L202 | [
"def",
"attach_to_tangle",
"(",
"self",
",",
"trunk_transaction",
",",
"# type: TransactionHash",
"branch_transaction",
",",
"# type: TransactionHash",
"trytes",
",",
"# type: Iterable[TryteString]",
"min_weight_magnitude",
"=",
"None",
",",
"# type: Optional[int]",
")",
":",... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | StrictIota.find_transactions | Find the transactions which match the specified input and
return.
All input values are lists, for which a list of return values
(transaction hashes), in the same order, is returned for all
individual elements.
Using multiple of these input fields returns the intersection of
... | iota/api.py | def find_transactions(
self,
bundles=None, # type: Optional[Iterable[BundleHash]]
addresses=None, # type: Optional[Iterable[Address]]
tags=None, # type: Optional[Iterable[Tag]]
approvees=None, # type: Optional[Iterable[TransactionHash]]
):
# ty... | def find_transactions(
self,
bundles=None, # type: Optional[Iterable[BundleHash]]
addresses=None, # type: Optional[Iterable[Address]]
tags=None, # type: Optional[Iterable[Tag]]
approvees=None, # type: Optional[Iterable[TransactionHash]]
):
# ty... | [
"Find",
"the",
"transactions",
"which",
"match",
"the",
"specified",
"input",
"and",
"return",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L249-L289 | [
"def",
"find_transactions",
"(",
"self",
",",
"bundles",
"=",
"None",
",",
"# type: Optional[Iterable[BundleHash]]",
"addresses",
"=",
"None",
",",
"# type: Optional[Iterable[Address]]",
"tags",
"=",
"None",
",",
"# type: Optional[Iterable[Tag]]",
"approvees",
"=",
"None"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | StrictIota.get_balances | Similar to :py:meth:`get_inclusion_states`. Returns the
confirmed balance which a list of addresses have at the latest
confirmed milestone.
In addition to the balances, it also returns the milestone as
well as the index with which the confirmed balance was
determined. The balan... | iota/api.py | def get_balances(self, addresses, threshold=100):
# type: (Iterable[Address], int) -> dict
"""
Similar to :py:meth:`get_inclusion_states`. Returns the
confirmed balance which a list of addresses have at the latest
confirmed milestone.
In addition to the balances, it also... | def get_balances(self, addresses, threshold=100):
# type: (Iterable[Address], int) -> dict
"""
Similar to :py:meth:`get_inclusion_states`. Returns the
confirmed balance which a list of addresses have at the latest
confirmed milestone.
In addition to the balances, it also... | [
"Similar",
"to",
":",
"py",
":",
"meth",
":",
"get_inclusion_states",
".",
"Returns",
"the",
"confirmed",
"balance",
"which",
"a",
"list",
"of",
"addresses",
"have",
"at",
"the",
"latest",
"confirmed",
"milestone",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L291-L316 | [
"def",
"get_balances",
"(",
"self",
",",
"addresses",
",",
"threshold",
"=",
"100",
")",
":",
"# type: (Iterable[Address], int) -> dict",
"return",
"core",
".",
"GetBalancesCommand",
"(",
"self",
".",
"adapter",
")",
"(",
"addresses",
"=",
"addresses",
",",
"thr... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | StrictIota.get_inclusion_states | Get the inclusion states of a set of transactions. This is for
determining if a transaction was accepted and confirmed by the
network or not. You can search for multiple tips (and thus,
milestones) to get past inclusion states of transactions.
:param transactions:
List of tr... | iota/api.py | def get_inclusion_states(self, transactions, tips):
# type: (Iterable[TransactionHash], Iterable[TransactionHash]) -> dict
"""
Get the inclusion states of a set of transactions. This is for
determining if a transaction was accepted and confirmed by the
network or not. You can sea... | def get_inclusion_states(self, transactions, tips):
# type: (Iterable[TransactionHash], Iterable[TransactionHash]) -> dict
"""
Get the inclusion states of a set of transactions. This is for
determining if a transaction was accepted and confirmed by the
network or not. You can sea... | [
"Get",
"the",
"inclusion",
"states",
"of",
"a",
"set",
"of",
"transactions",
".",
"This",
"is",
"for",
"determining",
"if",
"a",
"transaction",
"was",
"accepted",
"and",
"confirmed",
"by",
"the",
"network",
"or",
"not",
".",
"You",
"can",
"search",
"for",
... | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L318-L341 | [
"def",
"get_inclusion_states",
"(",
"self",
",",
"transactions",
",",
"tips",
")",
":",
"# type: (Iterable[TransactionHash], Iterable[TransactionHash]) -> dict",
"return",
"core",
".",
"GetInclusionStatesCommand",
"(",
"self",
".",
"adapter",
")",
"(",
"transactions",
"="... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.get_account_data | More comprehensive version of :py:meth:`get_transfers` that
returns addresses and account balance in addition to bundles.
This function is useful in getting all the relevant information
of your account.
:param start:
Starting key index.
:param stop:
Sto... | iota/api.py | def get_account_data(self, start=0, stop=None, inclusion_states=False, security_level=None):
# type: (int, Optional[int], bool, Optional[int]) -> dict
"""
More comprehensive version of :py:meth:`get_transfers` that
returns addresses and account balance in addition to bundles.
Th... | def get_account_data(self, start=0, stop=None, inclusion_states=False, security_level=None):
# type: (int, Optional[int], bool, Optional[int]) -> dict
"""
More comprehensive version of :py:meth:`get_transfers` that
returns addresses and account balance in addition to bundles.
Th... | [
"More",
"comprehensive",
"version",
"of",
":",
"py",
":",
"meth",
":",
"get_transfers",
"that",
"returns",
"addresses",
"and",
"account",
"balance",
"in",
"addition",
"to",
"bundles",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L520-L581 | [
"def",
"get_account_data",
"(",
"self",
",",
"start",
"=",
"0",
",",
"stop",
"=",
"None",
",",
"inclusion_states",
"=",
"False",
",",
"security_level",
"=",
"None",
")",
":",
"# type: (int, Optional[int], bool, Optional[int]) -> dict",
"return",
"extended",
".",
"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.get_inputs | Gets all possible inputs of a seed and returns them, along with
the total balance.
This is either done deterministically (by generating all
addresses until :py:meth:`find_transactions` returns an empty
result), or by providing a key range to search.
:param start:
St... | iota/api.py | def get_inputs(
self,
start=0,
stop=None,
threshold=None,
security_level=None,
):
# type: (int, Optional[int], Optional[int], Optional[int]) -> dict
"""
Gets all possible inputs of a seed and returns them, along with
the tot... | def get_inputs(
self,
start=0,
stop=None,
threshold=None,
security_level=None,
):
# type: (int, Optional[int], Optional[int], Optional[int]) -> dict
"""
Gets all possible inputs of a seed and returns them, along with
the tot... | [
"Gets",
"all",
"possible",
"inputs",
"of",
"a",
"seed",
"and",
"returns",
"them",
"along",
"with",
"the",
"total",
"balance",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L611-L708 | [
"def",
"get_inputs",
"(",
"self",
",",
"start",
"=",
"0",
",",
"stop",
"=",
"None",
",",
"threshold",
"=",
"None",
",",
"security_level",
"=",
"None",
",",
")",
":",
"# type: (int, Optional[int], Optional[int], Optional[int]) -> dict",
"return",
"extended",
".",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.get_new_addresses | Generates one or more new addresses from the seed.
:param index:
The key index of the first new address to generate (must be
>= 1).
:param count:
Number of addresses to generate (must be >= 1).
.. tip::
This is more efficient than callin... | iota/api.py | def get_new_addresses(
self,
index=0,
count=1,
security_level=AddressGenerator.DEFAULT_SECURITY_LEVEL,
checksum=False,
):
# type: (int, Optional[int], int, bool) -> dict
"""
Generates one or more new addresses from the seed.
... | def get_new_addresses(
self,
index=0,
count=1,
security_level=AddressGenerator.DEFAULT_SECURITY_LEVEL,
checksum=False,
):
# type: (int, Optional[int], int, bool) -> dict
"""
Generates one or more new addresses from the seed.
... | [
"Generates",
"one",
"or",
"more",
"new",
"addresses",
"from",
"the",
"seed",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L732-L789 | [
"def",
"get_new_addresses",
"(",
"self",
",",
"index",
"=",
"0",
",",
"count",
"=",
"1",
",",
"security_level",
"=",
"AddressGenerator",
".",
"DEFAULT_SECURITY_LEVEL",
",",
"checksum",
"=",
"False",
",",
")",
":",
"# type: (int, Optional[int], int, bool) -> dict",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.get_transfers | Returns all transfers associated with the seed.
:param start:
Starting key index.
:param stop:
Stop before this index.
Note that this parameter behaves like the ``stop`` attribute
in a :py:class:`slice` object; the stop index is *not*
includ... | iota/api.py | def get_transfers(self, start=0, stop=None, inclusion_states=False):
# type: (int, Optional[int], bool) -> dict
"""
Returns all transfers associated with the seed.
:param start:
Starting key index.
:param stop:
Stop before this index.
Note t... | def get_transfers(self, start=0, stop=None, inclusion_states=False):
# type: (int, Optional[int], bool) -> dict
"""
Returns all transfers associated with the seed.
:param start:
Starting key index.
:param stop:
Stop before this index.
Note t... | [
"Returns",
"all",
"transfers",
"associated",
"with",
"the",
"seed",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L791-L836 | [
"def",
"get_transfers",
"(",
"self",
",",
"start",
"=",
"0",
",",
"stop",
"=",
"None",
",",
"inclusion_states",
"=",
"False",
")",
":",
"# type: (int, Optional[int], bool) -> dict",
"return",
"extended",
".",
"GetTransfersCommand",
"(",
"self",
".",
"adapter",
"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.prepare_transfer | Prepares transactions to be broadcast to the Tangle, by
generating the correct bundle, as well as choosing and signing
the inputs (for value transfers).
:param transfers:
Transaction objects to prepare.
:param inputs:
List of addresses used to fund the transfer.... | iota/api.py | def prepare_transfer(
self,
transfers, # type: Iterable[ProposedTransaction]
inputs=None, # type: Optional[Iterable[Address]]
change_address=None, # type: Optional[Address]
security_level=None, # type: Optional[int]
):
# type: (...) -> dict
... | def prepare_transfer(
self,
transfers, # type: Iterable[ProposedTransaction]
inputs=None, # type: Optional[Iterable[Address]]
change_address=None, # type: Optional[Address]
security_level=None, # type: Optional[int]
):
# type: (...) -> dict
... | [
"Prepares",
"transactions",
"to",
"be",
"broadcast",
"to",
"the",
"Tangle",
"by",
"generating",
"the",
"correct",
"bundle",
"as",
"well",
"as",
"choosing",
"and",
"signing",
"the",
"inputs",
"(",
"for",
"value",
"transfers",
")",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L838-L898 | [
"def",
"prepare_transfer",
"(",
"self",
",",
"transfers",
",",
"# type: Iterable[ProposedTransaction]",
"inputs",
"=",
"None",
",",
"# type: Optional[Iterable[Address]]",
"change_address",
"=",
"None",
",",
"# type: Optional[Address]",
"security_level",
"=",
"None",
",",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.promote_transaction | Promotes a transaction by adding spam on top of it.
:return:
Dict with the following structure::
{
'bundle': Bundle,
The newly-published bundle.
} | iota/api.py | def promote_transaction(
self,
transaction,
depth=3,
min_weight_magnitude=None,
):
# type: (TransactionHash, int, Optional[int]) -> dict
"""
Promotes a transaction by adding spam on top of it.
:return:
Dict with the followi... | def promote_transaction(
self,
transaction,
depth=3,
min_weight_magnitude=None,
):
# type: (TransactionHash, int, Optional[int]) -> dict
"""
Promotes a transaction by adding spam on top of it.
:return:
Dict with the followi... | [
"Promotes",
"a",
"transaction",
"by",
"adding",
"spam",
"on",
"top",
"of",
"it",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L900-L925 | [
"def",
"promote_transaction",
"(",
"self",
",",
"transaction",
",",
"depth",
"=",
"3",
",",
"min_weight_magnitude",
"=",
"None",
",",
")",
":",
"# type: (TransactionHash, int, Optional[int]) -> dict",
"if",
"min_weight_magnitude",
"is",
"None",
":",
"min_weight_magnitud... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.replay_bundle | Takes a tail transaction hash as input, gets the bundle
associated with the transaction and then replays the bundle by
attaching it to the Tangle.
:param transaction:
Transaction hash. Must be a tail.
:param depth:
Depth at which to attach the bundle.
... | iota/api.py | def replay_bundle(
self,
transaction,
depth=3,
min_weight_magnitude=None,
):
# type: (TransactionHash, int, Optional[int]) -> dict
"""
Takes a tail transaction hash as input, gets the bundle
associated with the transaction and then repl... | def replay_bundle(
self,
transaction,
depth=3,
min_weight_magnitude=None,
):
# type: (TransactionHash, int, Optional[int]) -> dict
"""
Takes a tail transaction hash as input, gets the bundle
associated with the transaction and then repl... | [
"Takes",
"a",
"tail",
"transaction",
"hash",
"as",
"input",
"gets",
"the",
"bundle",
"associated",
"with",
"the",
"transaction",
"and",
"then",
"replays",
"the",
"bundle",
"by",
"attaching",
"it",
"to",
"the",
"Tangle",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L927-L971 | [
"def",
"replay_bundle",
"(",
"self",
",",
"transaction",
",",
"depth",
"=",
"3",
",",
"min_weight_magnitude",
"=",
"None",
",",
")",
":",
"# type: (TransactionHash, int, Optional[int]) -> dict",
"if",
"min_weight_magnitude",
"is",
"None",
":",
"min_weight_magnitude",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.send_transfer | Prepares a set of transfers and creates the bundle, then
attaches the bundle to the Tangle, and broadcasts and stores the
transactions.
:param transfers:
Transfers to include in the bundle.
:param depth:
Depth at which to attach the bundle.
Defaults ... | iota/api.py | def send_transfer(
self,
transfers, # type: Iterable[ProposedTransaction]
depth=3, # type: int
inputs=None, # type: Optional[Iterable[Address]]
change_address=None, # type: Optional[Address]
min_weight_magnitude=None, # type: Optional[int]
... | def send_transfer(
self,
transfers, # type: Iterable[ProposedTransaction]
depth=3, # type: int
inputs=None, # type: Optional[Iterable[Address]]
change_address=None, # type: Optional[Address]
min_weight_magnitude=None, # type: Optional[int]
... | [
"Prepares",
"a",
"set",
"of",
"transfers",
"and",
"creates",
"the",
"bundle",
"then",
"attaches",
"the",
"bundle",
"to",
"the",
"Tangle",
"and",
"broadcasts",
"and",
"stores",
"the",
"transactions",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L973-L1044 | [
"def",
"send_transfer",
"(",
"self",
",",
"transfers",
",",
"# type: Iterable[ProposedTransaction]",
"depth",
"=",
"3",
",",
"# type: int",
"inputs",
"=",
"None",
",",
"# type: Optional[Iterable[Address]]",
"change_address",
"=",
"None",
",",
"# type: Optional[Address]",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Iota.send_trytes | Attaches transaction trytes to the Tangle, then broadcasts and
stores them.
:param trytes:
Transaction encoded as a tryte sequence.
:param depth:
Depth at which to attach the bundle.
Defaults to 3.
:param min_weight_magnitude:
Min weight... | iota/api.py | def send_trytes(self, trytes, depth=3, min_weight_magnitude=None):
# type: (Iterable[TransactionTrytes], int, Optional[int]) -> dict
"""
Attaches transaction trytes to the Tangle, then broadcasts and
stores them.
:param trytes:
Transaction encoded as a tryte sequence... | def send_trytes(self, trytes, depth=3, min_weight_magnitude=None):
# type: (Iterable[TransactionTrytes], int, Optional[int]) -> dict
"""
Attaches transaction trytes to the Tangle, then broadcasts and
stores them.
:param trytes:
Transaction encoded as a tryte sequence... | [
"Attaches",
"transaction",
"trytes",
"to",
"the",
"Tangle",
"then",
"broadcasts",
"and",
"stores",
"them",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/api.py#L1046-L1084 | [
"def",
"send_trytes",
"(",
"self",
",",
"trytes",
",",
"depth",
"=",
"3",
",",
"min_weight_magnitude",
"=",
"None",
")",
":",
"# type: (Iterable[TransactionTrytes], int, Optional[int]) -> dict",
"if",
"min_weight_magnitude",
"is",
"None",
":",
"min_weight_magnitude",
"=... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | resolve_adapter | Given a URI, returns a properly-configured adapter instance. | iota/adapter/__init__.py | def resolve_adapter(uri):
# type: (AdapterSpec) -> BaseAdapter
"""
Given a URI, returns a properly-configured adapter instance.
"""
if isinstance(uri, BaseAdapter):
return uri
parsed = compat.urllib_parse.urlsplit(uri) # type: SplitResult
if not parsed.scheme:
raise with_c... | def resolve_adapter(uri):
# type: (AdapterSpec) -> BaseAdapter
"""
Given a URI, returns a properly-configured adapter instance.
"""
if isinstance(uri, BaseAdapter):
return uri
parsed = compat.urllib_parse.urlsplit(uri) # type: SplitResult
if not parsed.scheme:
raise with_c... | [
"Given",
"a",
"URI",
"returns",
"a",
"properly",
"-",
"configured",
"adapter",
"instance",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/adapter/__init__.py#L77-L113 | [
"def",
"resolve_adapter",
"(",
"uri",
")",
":",
"# type: (AdapterSpec) -> BaseAdapter",
"if",
"isinstance",
"(",
"uri",
",",
"BaseAdapter",
")",
":",
"return",
"uri",
"parsed",
"=",
"compat",
".",
"urllib_parse",
".",
"urlsplit",
"(",
"uri",
")",
"# type: SplitR... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | BaseAdapter.send_request | Sends an API request to the node.
:param payload:
JSON payload.
:param kwargs:
Additional keyword arguments for the adapter.
:return:
Decoded response from the node.
:raise:
- :py:class:`BadApiResponse` if a non-success response was
... | iota/adapter/__init__.py | def send_request(self, payload, **kwargs):
# type: (dict, dict) -> dict
"""
Sends an API request to the node.
:param payload:
JSON payload.
:param kwargs:
Additional keyword arguments for the adapter.
:return:
Decoded response from t... | def send_request(self, payload, **kwargs):
# type: (dict, dict) -> dict
"""
Sends an API request to the node.
:param payload:
JSON payload.
:param kwargs:
Additional keyword arguments for the adapter.
:return:
Decoded response from t... | [
"Sends",
"an",
"API",
"request",
"to",
"the",
"node",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/adapter/__init__.py#L171-L191 | [
"def",
"send_request",
"(",
"self",
",",
"payload",
",",
"*",
"*",
"kwargs",
")",
":",
"# type: (dict, dict) -> dict",
"raise",
"NotImplementedError",
"(",
"'Not implemented in {cls}.'",
".",
"format",
"(",
"cls",
"=",
"type",
"(",
"self",
")",
".",
"__name__",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | BaseAdapter._log | Sends a message to the instance's logger, if configured. | iota/adapter/__init__.py | def _log(self, level, message, context=None):
# type: (int, Text, Optional[dict]) -> None
"""
Sends a message to the instance's logger, if configured.
"""
if self._logger:
self._logger.log(level, message, extra={'context': context or {}}) | def _log(self, level, message, context=None):
# type: (int, Text, Optional[dict]) -> None
"""
Sends a message to the instance's logger, if configured.
"""
if self._logger:
self._logger.log(level, message, extra={'context': context or {}}) | [
"Sends",
"a",
"message",
"to",
"the",
"instance",
"s",
"logger",
"if",
"configured",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/adapter/__init__.py#L203-L209 | [
"def",
"_log",
"(",
"self",
",",
"level",
",",
"message",
",",
"context",
"=",
"None",
")",
":",
"# type: (int, Text, Optional[dict]) -> None",
"if",
"self",
".",
"_logger",
":",
"self",
".",
"_logger",
".",
"log",
"(",
"level",
",",
"message",
",",
"extra... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | HttpAdapter._send_http_request | Sends the actual HTTP request.
Split into its own method so that it can be mocked during unit
tests. | iota/adapter/__init__.py | def _send_http_request(self, url, payload, method='post', **kwargs):
# type: (Text, Optional[Text], Text, dict) -> Response
"""
Sends the actual HTTP request.
Split into its own method so that it can be mocked during unit
tests.
"""
kwargs.setdefault(
... | def _send_http_request(self, url, payload, method='post', **kwargs):
# type: (Text, Optional[Text], Text, dict) -> Response
"""
Sends the actual HTTP request.
Split into its own method so that it can be mocked during unit
tests.
"""
kwargs.setdefault(
... | [
"Sends",
"the",
"actual",
"HTTP",
"request",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/adapter/__init__.py#L311-L366 | [
"def",
"_send_http_request",
"(",
"self",
",",
"url",
",",
"payload",
",",
"method",
"=",
"'post'",
",",
"*",
"*",
"kwargs",
")",
":",
"# type: (Text, Optional[Text], Text, dict) -> Response",
"kwargs",
".",
"setdefault",
"(",
"'timeout'",
",",
"self",
".",
"tim... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | HttpAdapter._interpret_response | Interprets the HTTP response from the node.
:param response:
The response object received from
:py:meth:`_send_http_request`.
:param payload:
The request payload that was sent (used for debugging).
:param expected_status:
The response should mat... | iota/adapter/__init__.py | def _interpret_response(self, response, payload, expected_status):
# type: (Response, dict, Container[int]) -> dict
"""
Interprets the HTTP response from the node.
:param response:
The response object received from
:py:meth:`_send_http_request`.
:param p... | def _interpret_response(self, response, payload, expected_status):
# type: (Response, dict, Container[int]) -> dict
"""
Interprets the HTTP response from the node.
:param response:
The response object received from
:py:meth:`_send_http_request`.
:param p... | [
"Interprets",
"the",
"HTTP",
"response",
"from",
"the",
"node",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/adapter/__init__.py#L368-L456 | [
"def",
"_interpret_response",
"(",
"self",
",",
"response",
",",
"payload",
",",
"expected_status",
")",
":",
"# type: (Response, dict, Container[int]) -> dict",
"raw_content",
"=",
"response",
".",
"text",
"if",
"not",
"raw_content",
":",
"raise",
"with_context",
"("... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | MockAdapter.seed_response | Sets the response that the adapter will return for the specified
command.
You can seed multiple responses per command; the adapter will
put them into a FIFO queue. When a request comes in, the
adapter will pop the corresponding response off of the queue.
Example:
.. c... | iota/adapter/__init__.py | def seed_response(self, command, response):
# type: (Text, dict) -> MockAdapter
"""
Sets the response that the adapter will return for the specified
command.
You can seed multiple responses per command; the adapter will
put them into a FIFO queue. When a request comes i... | def seed_response(self, command, response):
# type: (Text, dict) -> MockAdapter
"""
Sets the response that the adapter will return for the specified
command.
You can seed multiple responses per command; the adapter will
put them into a FIFO queue. When a request comes i... | [
"Sets",
"the",
"response",
"that",
"the",
"adapter",
"will",
"return",
"for",
"the",
"specified",
"command",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/adapter/__init__.py#L483-L510 | [
"def",
"seed_response",
"(",
"self",
",",
"command",
",",
"response",
")",
":",
"# type: (Text, dict) -> MockAdapter",
"if",
"command",
"not",
"in",
"self",
".",
"responses",
":",
"self",
".",
"responses",
"[",
"command",
"]",
"=",
"deque",
"(",
")",
"self",... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | MultisigAddressBuilder.add_digest | Absorbs a digest into the sponge.
.. important::
Keep track of the order that digests are added!
To spend inputs from a multisig address, you must provide
the private keys in the same order!
References:
- https://github.com/iotaledger/wiki/blob/master/mult... | iota/multisig/crypto/addresses.py | def add_digest(self, digest):
# type: (Digest) -> None
"""
Absorbs a digest into the sponge.
.. important::
Keep track of the order that digests are added!
To spend inputs from a multisig address, you must provide
the private keys in the same order!
... | def add_digest(self, digest):
# type: (Digest) -> None
"""
Absorbs a digest into the sponge.
.. important::
Keep track of the order that digests are added!
To spend inputs from a multisig address, you must provide
the private keys in the same order!
... | [
"Absorbs",
"a",
"digest",
"into",
"the",
"sponge",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/multisig/crypto/addresses.py#L47-L66 | [
"def",
"add_digest",
"(",
"self",
",",
"digest",
")",
":",
"# type: (Digest) -> None",
"if",
"self",
".",
"_address",
":",
"raise",
"ValueError",
"(",
"'Cannot add digests once an address is extracted.'",
")",
"self",
".",
"_sponge",
".",
"absorb",
"(",
"digest",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | MultisigAddressBuilder.get_address | Returns the new multisig address.
Note that you can continue to add digests after extracting an
address; the next address will use *all* of the digests that
have been added so far. | iota/multisig/crypto/addresses.py | def get_address(self):
# type: () -> MultisigAddress
"""
Returns the new multisig address.
Note that you can continue to add digests after extracting an
address; the next address will use *all* of the digests that
have been added so far.
"""
if not self._... | def get_address(self):
# type: () -> MultisigAddress
"""
Returns the new multisig address.
Note that you can continue to add digests after extracting an
address; the next address will use *all* of the digests that
have been added so far.
"""
if not self._... | [
"Returns",
"the",
"new",
"multisig",
"address",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/multisig/crypto/addresses.py#L68-L92 | [
"def",
"get_address",
"(",
"self",
")",
":",
"# type: () -> MultisigAddress",
"if",
"not",
"self",
".",
"_digests",
":",
"raise",
"ValueError",
"(",
"'Must call ``add_digest`` at least once '",
"'before calling ``get_address``.'",
",",
")",
"if",
"not",
"self",
".",
"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | AddressGenerator.get_addresses | Generates and returns one or more addresses at the specified
index(es).
This is a one-time operation; if you want to create lots of
addresses across multiple contexts, consider invoking
:py:meth:`create_iterator` and sharing the resulting generator
object instead.
Warni... | iota/crypto/addresses.py | def get_addresses(self, start, count=1, step=1):
# type: (int, int, int) -> List[Address]
"""
Generates and returns one or more addresses at the specified
index(es).
This is a one-time operation; if you want to create lots of
addresses across multiple contexts, consider ... | def get_addresses(self, start, count=1, step=1):
# type: (int, int, int) -> List[Address]
"""
Generates and returns one or more addresses at the specified
index(es).
This is a one-time operation; if you want to create lots of
addresses across multiple contexts, consider ... | [
"Generates",
"and",
"returns",
"one",
"or",
"more",
"addresses",
"at",
"the",
"specified",
"index",
"(",
"es",
")",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/addresses.py#L65-L132 | [
"def",
"get_addresses",
"(",
"self",
",",
"start",
",",
"count",
"=",
"1",
",",
"step",
"=",
"1",
")",
":",
"# type: (int, int, int) -> List[Address]",
"if",
"count",
"<",
"1",
":",
"raise",
"with_context",
"(",
"exc",
"=",
"ValueError",
"(",
"'``count`` mus... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | AddressGenerator.create_iterator | Creates an iterator that can be used to progressively generate new
addresses.
:param start:
Starting index.
Warning: This method may take awhile to reset if ``start``
is a large number!
:param step:
Number of indexes to advance after each addres... | iota/crypto/addresses.py | def create_iterator(self, start=0, step=1):
# type: (int, int) -> Generator[Address, None, None]
"""
Creates an iterator that can be used to progressively generate new
addresses.
:param start:
Starting index.
Warning: This method may take awhile to reset... | def create_iterator(self, start=0, step=1):
# type: (int, int) -> Generator[Address, None, None]
"""
Creates an iterator that can be used to progressively generate new
addresses.
:param start:
Starting index.
Warning: This method may take awhile to reset... | [
"Creates",
"an",
"iterator",
"that",
"can",
"be",
"used",
"to",
"progressively",
"generate",
"new",
"addresses",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/addresses.py#L134-L161 | [
"def",
"create_iterator",
"(",
"self",
",",
"start",
"=",
"0",
",",
"step",
"=",
"1",
")",
":",
"# type: (int, int) -> Generator[Address, None, None]",
"key_iterator",
"=",
"(",
"KeyGenerator",
"(",
"self",
".",
"seed",
")",
".",
"create_iterator",
"(",
"start",... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | AddressGenerator.address_from_digest | Generates an address from a private key digest. | iota/crypto/addresses.py | def address_from_digest(digest):
# type: (Digest) -> Address
"""
Generates an address from a private key digest.
"""
address_trits = [0] * (Address.LEN * TRITS_PER_TRYTE) # type: List[int]
sponge = Kerl()
sponge.absorb(digest.as_trits())
sponge.squeeze(a... | def address_from_digest(digest):
# type: (Digest) -> Address
"""
Generates an address from a private key digest.
"""
address_trits = [0] * (Address.LEN * TRITS_PER_TRYTE) # type: List[int]
sponge = Kerl()
sponge.absorb(digest.as_trits())
sponge.squeeze(a... | [
"Generates",
"an",
"address",
"from",
"a",
"private",
"key",
"digest",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/addresses.py#L164-L180 | [
"def",
"address_from_digest",
"(",
"digest",
")",
":",
"# type: (Digest) -> Address",
"address_trits",
"=",
"[",
"0",
"]",
"*",
"(",
"Address",
".",
"LEN",
"*",
"TRITS_PER_TRYTE",
")",
"# type: List[int]",
"sponge",
"=",
"Kerl",
"(",
")",
"sponge",
".",
"absor... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | AddressGenerator._generate_address | Generates a new address.
Used in the event of a cache miss. | iota/crypto/addresses.py | def _generate_address(self, key_iterator):
# type: (KeyIterator) -> Address
"""
Generates a new address.
Used in the event of a cache miss.
"""
if self.checksum:
return (
self.address_from_digest(
digest=self._get_digest(ke... | def _generate_address(self, key_iterator):
# type: (KeyIterator) -> Address
"""
Generates a new address.
Used in the event of a cache miss.
"""
if self.checksum:
return (
self.address_from_digest(
digest=self._get_digest(ke... | [
"Generates",
"a",
"new",
"address",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/crypto/addresses.py#L182-L196 | [
"def",
"_generate_address",
"(",
"self",
",",
"key_iterator",
")",
":",
"# type: (KeyIterator) -> Address",
"if",
"self",
".",
"checksum",
":",
"return",
"(",
"self",
".",
"address_from_digest",
"(",
"digest",
"=",
"self",
".",
"_get_digest",
"(",
"key_iterator",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | find_transaction_objects | Finds transactions matching the specified criteria, fetches the
corresponding trytes and converts them into Transaction objects. | iota/commands/extended/utils.py | def find_transaction_objects(adapter, **kwargs):
# type: (BaseAdapter, **Iterable) -> List[Transaction]
"""
Finds transactions matching the specified criteria, fetches the
corresponding trytes and converts them into Transaction objects.
"""
ft_response = FindTransactionsCommand(adapter)(**kwargs... | def find_transaction_objects(adapter, **kwargs):
# type: (BaseAdapter, **Iterable) -> List[Transaction]
"""
Finds transactions matching the specified criteria, fetches the
corresponding trytes and converts them into Transaction objects.
"""
ft_response = FindTransactionsCommand(adapter)(**kwargs... | [
"Finds",
"transactions",
"matching",
"the",
"specified",
"criteria",
"fetches",
"the",
"corresponding",
"trytes",
"and",
"converts",
"them",
"into",
"Transaction",
"objects",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/commands/extended/utils.py#L19-L37 | [
"def",
"find_transaction_objects",
"(",
"adapter",
",",
"*",
"*",
"kwargs",
")",
":",
"# type: (BaseAdapter, **Iterable) -> List[Transaction]",
"ft_response",
"=",
"FindTransactionsCommand",
"(",
"adapter",
")",
"(",
"*",
"*",
"kwargs",
")",
"hashes",
"=",
"ft_respons... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | iter_used_addresses | Scans the Tangle for used addresses.
This is basically the opposite of invoking ``getNewAddresses`` with
``stop=None``. | iota/commands/extended/utils.py | def iter_used_addresses(
adapter, # type: BaseAdapter
seed, # type: Seed
start, # type: int
security_level=None, # type: Optional[int]
):
# type: (...) -> Generator[Tuple[Address, List[TransactionHash]], None, None]
"""
Scans the Tangle for used addresses.
This is ba... | def iter_used_addresses(
adapter, # type: BaseAdapter
seed, # type: Seed
start, # type: int
security_level=None, # type: Optional[int]
):
# type: (...) -> Generator[Tuple[Address, List[TransactionHash]], None, None]
"""
Scans the Tangle for used addresses.
This is ba... | [
"Scans",
"the",
"Tangle",
"for",
"used",
"addresses",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/commands/extended/utils.py#L40-L67 | [
"def",
"iter_used_addresses",
"(",
"adapter",
",",
"# type: BaseAdapter",
"seed",
",",
"# type: Seed",
"start",
",",
"# type: int",
"security_level",
"=",
"None",
",",
"# type: Optional[int]",
")",
":",
"# type: (...) -> Generator[Tuple[Address, List[TransactionHash]], None, No... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | get_bundles_from_transaction_hashes | Given a set of transaction hashes, returns the corresponding bundles,
sorted by tail transaction timestamp. | iota/commands/extended/utils.py | def get_bundles_from_transaction_hashes(
adapter,
transaction_hashes,
inclusion_states,
):
# type: (BaseAdapter, Iterable[TransactionHash], bool) -> List[Bundle]
"""
Given a set of transaction hashes, returns the corresponding bundles,
sorted by tail transaction timestamp.
""... | def get_bundles_from_transaction_hashes(
adapter,
transaction_hashes,
inclusion_states,
):
# type: (BaseAdapter, Iterable[TransactionHash], bool) -> List[Bundle]
"""
Given a set of transaction hashes, returns the corresponding bundles,
sorted by tail transaction timestamp.
""... | [
"Given",
"a",
"set",
"of",
"transaction",
"hashes",
"returns",
"the",
"corresponding",
"bundles",
"sorted",
"by",
"tail",
"transaction",
"timestamp",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/commands/extended/utils.py#L70-L145 | [
"def",
"get_bundles_from_transaction_hashes",
"(",
"adapter",
",",
"transaction_hashes",
",",
"inclusion_states",
",",
")",
":",
"# type: (BaseAdapter, Iterable[TransactionHash], bool) -> List[Bundle]",
"transaction_hashes",
"=",
"list",
"(",
"transaction_hashes",
")",
"if",
"n... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | ProposedMultisigBundle.add_inputs | Adds inputs to spend in the bundle.
Note that each input may require multiple transactions, in order to
hold the entire signature.
:param inputs:
MultisigAddresses to use as the inputs for this bundle.
Note: at this time, only a single multisig input is supported. | iota/multisig/transaction.py | def add_inputs(self, inputs):
# type: (Iterable[MultisigAddress]) -> None
"""
Adds inputs to spend in the bundle.
Note that each input may require multiple transactions, in order to
hold the entire signature.
:param inputs:
MultisigAddresses to use as the inputs for this bundle.
N... | def add_inputs(self, inputs):
# type: (Iterable[MultisigAddress]) -> None
"""
Adds inputs to spend in the bundle.
Note that each input may require multiple transactions, in order to
hold the entire signature.
:param inputs:
MultisigAddresses to use as the inputs for this bundle.
N... | [
"Adds",
"inputs",
"to",
"spend",
"in",
"the",
"bundle",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/multisig/transaction.py#L22-L96 | [
"def",
"add_inputs",
"(",
"self",
",",
"inputs",
")",
":",
"# type: (Iterable[MultisigAddress]) -> None",
"if",
"self",
".",
"hash",
":",
"raise",
"RuntimeError",
"(",
"'Bundle is already finalized.'",
")",
"count",
"=",
"0",
"for",
"addy",
"in",
"inputs",
":",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | check_trytes_codec | Determines which codec to use for the specified encoding.
References:
- https://docs.python.org/3/library/codecs.html#codecs.register | iota/codecs.py | def check_trytes_codec(encoding):
"""
Determines which codec to use for the specified encoding.
References:
- https://docs.python.org/3/library/codecs.html#codecs.register
"""
if encoding == AsciiTrytesCodec.name:
return AsciiTrytesCodec.get_codec_info()
elif encoding == AsciiTryt... | def check_trytes_codec(encoding):
"""
Determines which codec to use for the specified encoding.
References:
- https://docs.python.org/3/library/codecs.html#codecs.register
"""
if encoding == AsciiTrytesCodec.name:
return AsciiTrytesCodec.get_codec_info()
elif encoding == AsciiTryt... | [
"Determines",
"which",
"codec",
"to",
"use",
"for",
"the",
"specified",
"encoding",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/codecs.py#L197-L220 | [
"def",
"check_trytes_codec",
"(",
"encoding",
")",
":",
"if",
"encoding",
"==",
"AsciiTrytesCodec",
".",
"name",
":",
"return",
"AsciiTrytesCodec",
".",
"get_codec_info",
"(",
")",
"elif",
"encoding",
"==",
"AsciiTrytesCodec",
".",
"compat_name",
":",
"warn",
"(... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | AsciiTrytesCodec.get_codec_info | Returns information used by the codecs library to configure the
codec for use. | iota/codecs.py | def get_codec_info(cls):
"""
Returns information used by the codecs library to configure the
codec for use.
"""
codec = cls()
codec_info = {
'encode': codec.encode,
'decode': codec.decode,
}
# In Python 2, all codecs are made equa... | def get_codec_info(cls):
"""
Returns information used by the codecs library to configure the
codec for use.
"""
codec = cls()
codec_info = {
'encode': codec.encode,
'decode': codec.decode,
}
# In Python 2, all codecs are made equa... | [
"Returns",
"information",
"used",
"by",
"the",
"codecs",
"library",
"to",
"configure",
"the",
"codec",
"for",
"use",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/codecs.py#L61-L78 | [
"def",
"get_codec_info",
"(",
"cls",
")",
":",
"codec",
"=",
"cls",
"(",
")",
"codec_info",
"=",
"{",
"'encode'",
":",
"codec",
".",
"encode",
",",
"'decode'",
":",
"codec",
".",
"decode",
",",
"}",
"# In Python 2, all codecs are made equal.",
"# In Python 3, ... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | AsciiTrytesCodec.encode | Encodes a byte string into trytes. | iota/codecs.py | def encode(self, input, errors='strict'):
"""
Encodes a byte string into trytes.
"""
if isinstance(input, memoryview):
input = input.tobytes()
if not isinstance(input, (binary_type, bytearray)):
raise with_context(
exc=TypeError(
... | def encode(self, input, errors='strict'):
"""
Encodes a byte string into trytes.
"""
if isinstance(input, memoryview):
input = input.tobytes()
if not isinstance(input, (binary_type, bytearray)):
raise with_context(
exc=TypeError(
... | [
"Encodes",
"a",
"byte",
"string",
"into",
"trytes",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/codecs.py#L81-L113 | [
"def",
"encode",
"(",
"self",
",",
"input",
",",
"errors",
"=",
"'strict'",
")",
":",
"if",
"isinstance",
"(",
"input",
",",
"memoryview",
")",
":",
"input",
"=",
"input",
".",
"tobytes",
"(",
")",
"if",
"not",
"isinstance",
"(",
"input",
",",
"(",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | AsciiTrytesCodec.decode | Decodes a tryte string into bytes. | iota/codecs.py | def decode(self, input, errors='strict'):
"""
Decodes a tryte string into bytes.
"""
if isinstance(input, memoryview):
input = input.tobytes()
if not isinstance(input, (binary_type, bytearray)):
raise with_context(
exc=TypeError(
... | def decode(self, input, errors='strict'):
"""
Decodes a tryte string into bytes.
"""
if isinstance(input, memoryview):
input = input.tobytes()
if not isinstance(input, (binary_type, bytearray)):
raise with_context(
exc=TypeError(
... | [
"Decodes",
"a",
"tryte",
"string",
"into",
"bytes",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/codecs.py#L116-L193 | [
"def",
"decode",
"(",
"self",
",",
"input",
",",
"errors",
"=",
"'strict'",
")",
":",
"if",
"isinstance",
"(",
"input",
",",
"memoryview",
")",
":",
"input",
"=",
"input",
".",
"tobytes",
"(",
")",
"if",
"not",
"isinstance",
"(",
"input",
",",
"(",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | GetNewAddressesCommand._find_addresses | Find addresses matching the command parameters. | iota/commands/extended/get_new_addresses.py | def _find_addresses(self, seed, index, count, security_level, checksum):
# type: (Seed, int, Optional[int], int, bool) -> List[Address]
"""
Find addresses matching the command parameters.
"""
generator = AddressGenerator(seed, security_level, checksum)
if count is None:
... | def _find_addresses(self, seed, index, count, security_level, checksum):
# type: (Seed, int, Optional[int], int, bool) -> List[Address]
"""
Find addresses matching the command parameters.
"""
generator = AddressGenerator(seed, security_level, checksum)
if count is None:
... | [
"Find",
"addresses",
"matching",
"the",
"command",
"parameters",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/commands/extended/get_new_addresses.py#L53-L73 | [
"def",
"_find_addresses",
"(",
"self",
",",
"seed",
",",
"index",
",",
"count",
",",
"security_level",
",",
"checksum",
")",
":",
"# type: (Seed, int, Optional[int], int, bool) -> List[Address]",
"generator",
"=",
"AddressGenerator",
"(",
"seed",
",",
"security_level",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | RoutingWrapper.add_route | Adds a route to the wrapper.
:param command:
The name of the command to route (e.g., "attachToTangle").
:param adapter:
The adapter object or URI to route requests to. | iota/adapter/wrappers.py | def add_route(self, command, adapter):
# type: (Text, AdapterSpec) -> RoutingWrapper
"""
Adds a route to the wrapper.
:param command:
The name of the command to route (e.g., "attachToTangle").
:param adapter:
The adapter object or URI to route requests t... | def add_route(self, command, adapter):
# type: (Text, AdapterSpec) -> RoutingWrapper
"""
Adds a route to the wrapper.
:param command:
The name of the command to route (e.g., "attachToTangle").
:param adapter:
The adapter object or URI to route requests t... | [
"Adds",
"a",
"route",
"to",
"the",
"wrapper",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/adapter/wrappers.py#L77-L98 | [
"def",
"add_route",
"(",
"self",
",",
"command",
",",
"adapter",
")",
":",
"# type: (Text, AdapterSpec) -> RoutingWrapper",
"if",
"not",
"isinstance",
"(",
"adapter",
",",
"BaseAdapter",
")",
":",
"try",
":",
"adapter",
"=",
"self",
".",
"adapter_aliases",
"[",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Transaction.from_tryte_string | Creates a Transaction object from a sequence of trytes.
:param trytes:
Raw trytes. Should be exactly 2673 trytes long.
:param hash_:
The transaction hash, if available.
If not provided, it will be computed from the transaction
trytes. | iota/transaction/base.py | def from_tryte_string(cls, trytes, hash_=None):
# type: (TrytesCompatible, Optional[TransactionHash]) -> Transaction
"""
Creates a Transaction object from a sequence of trytes.
:param trytes:
Raw trytes. Should be exactly 2673 trytes long.
:param hash_:
... | def from_tryte_string(cls, trytes, hash_=None):
# type: (TrytesCompatible, Optional[TransactionHash]) -> Transaction
"""
Creates a Transaction object from a sequence of trytes.
:param trytes:
Raw trytes. Should be exactly 2673 trytes long.
:param hash_:
... | [
"Creates",
"a",
"Transaction",
"object",
"from",
"a",
"sequence",
"of",
"trytes",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/transaction/base.py#L29-L78 | [
"def",
"from_tryte_string",
"(",
"cls",
",",
"trytes",
",",
"hash_",
"=",
"None",
")",
":",
"# type: (TrytesCompatible, Optional[TransactionHash]) -> Transaction",
"tryte_string",
"=",
"TransactionTrytes",
"(",
"trytes",
")",
"if",
"not",
"hash_",
":",
"hash_trits",
"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Transaction.as_json_compatible | Returns a JSON-compatible representation of the object.
References:
- :py:class:`iota.json.JsonEncoder`. | iota/transaction/base.py | def as_json_compatible(self):
# type: () -> dict
"""
Returns a JSON-compatible representation of the object.
References:
- :py:class:`iota.json.JsonEncoder`.
"""
return {
'hash_': self.hash,
'signature_message_fragment': self.signature_me... | def as_json_compatible(self):
# type: () -> dict
"""
Returns a JSON-compatible representation of the object.
References:
- :py:class:`iota.json.JsonEncoder`.
"""
return {
'hash_': self.hash,
'signature_message_fragment': self.signature_me... | [
"Returns",
"a",
"JSON",
"-",
"compatible",
"representation",
"of",
"the",
"object",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/transaction/base.py#L310-L341 | [
"def",
"as_json_compatible",
"(",
"self",
")",
":",
"# type: () -> dict",
"return",
"{",
"'hash_'",
":",
"self",
".",
"hash",
",",
"'signature_message_fragment'",
":",
"self",
".",
"signature_message_fragment",
",",
"'address'",
":",
"self",
".",
"address",
",",
... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
test | Transaction.as_tryte_string | Returns a TryteString representation of the transaction. | iota/transaction/base.py | def as_tryte_string(self):
# type: () -> TransactionTrytes
"""
Returns a TryteString representation of the transaction.
"""
return TransactionTrytes(
self.signature_message_fragment
+ self.address.address
+ self.value_as_trytes
+ se... | def as_tryte_string(self):
# type: () -> TransactionTrytes
"""
Returns a TryteString representation of the transaction.
"""
return TransactionTrytes(
self.signature_message_fragment
+ self.address.address
+ self.value_as_trytes
+ se... | [
"Returns",
"a",
"TryteString",
"representation",
"of",
"the",
"transaction",
"."
] | iotaledger/iota.lib.py | python | https://github.com/iotaledger/iota.lib.py/blob/97cdd1e241498446b46157b79b2a1ea2ec6d387a/iota/transaction/base.py#L343-L364 | [
"def",
"as_tryte_string",
"(",
"self",
")",
":",
"# type: () -> TransactionTrytes",
"return",
"TransactionTrytes",
"(",
"self",
".",
"signature_message_fragment",
"+",
"self",
".",
"address",
".",
"address",
"+",
"self",
".",
"value_as_trytes",
"+",
"self",
".",
"... | 97cdd1e241498446b46157b79b2a1ea2ec6d387a |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.