Skip to content

Commit

Permalink
Merge pull request sherlock-project#862 from jithin-renji/master
Browse files Browse the repository at this point in the history 
Consistent comment style
  • Loading branch information
@sdushantha
sdushantha committed Nov 14, 2020
2 parents ea58a0d + a02ea2d commit 9d824d1
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 39 deletions.
12 changes: 6 additions & 6 deletions sherlock/result.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ class QueryStatus(Enum):
Describes status of query about a given username.
"""
CLAIMED = "Claimed" #Username Detected
AVAILABLE = "Available" #Username Not Detected
UNKNOWN = "Unknown" #Error Occurred While Trying To Detect Username
ILLEGAL = "Illegal" #Username Not Allowable For This Site
CLAIMED = "Claimed" # Username Detected
AVAILABLE = "Available" # Username Not Detected
UNKNOWN = "Unknown" # Error Occurred While Trying To Detect Username
ILLEGAL = "Illegal" # Username Not Allowable For This Site

def __str__(self):
"""Convert Object To String.
Expand Down Expand Up @@ -81,8 +81,8 @@ def __str__(self):
"""
status = str(self.status)
if self.context is not None:
#There is extra context information available about the results.
#Append it to the normal response text.
# There is extra context information available about the results.
# Append it to the normal response text.
status += f" ({self.context})"

return status
62 changes: 31 additions & 31 deletions sherlock/sherlock.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ def request(self, method, url, hooks={}, *args, **kwargs):
Return Value:
Request object.
"""
#Record the start time for the request.
# Record the start time for the request.
start = monotonic()

def response_time(resp, *args, **kwargs):
Expand All @@ -70,22 +70,22 @@ def response_time(resp, *args, **kwargs):

return

#Install hook to execute when response completes.
#Make sure that the time measurement hook is first, so we will not
#track any later hook's execution time.
# Install hook to execute when response completes.
# Make sure that the time measurement hook is first, so we will not
# track any later hook's execution time.
try:
if isinstance(hooks['response'], list):
hooks['response'].insert(0, response_time)
elif isinstance(hooks['response'], tuple):
#Convert tuple to list and insert time measurement hook first.
# Convert tuple to list and insert time measurement hook first.
hooks['response'] = list(hooks['response'])
hooks['response'].insert(0, response_time)
else:
#Must have previously contained a single hook function,
#so convert to list.
# Must have previously contained a single hook function,
# so convert to list.
hooks['response'] = [response_time, hooks['response']]
except KeyError:
#No response hook was already defined, so install it ourselves.
# No response hook was already defined, so install it ourselves.
hooks['response'] = [response_time]

return super(SherlockFuturesSession, self).request(method,
Expand All @@ -96,15 +96,15 @@ def response_time(resp, *args, **kwargs):

def get_response(request_future, error_type, social_network):

#Default for Response object if some failure occurs.
# Default for Response object if some failure occurs.
response = None

error_context = "General Unknown Error"
expection_text = None
try:
response = request_future.result()
if response.status_code:
#status code exists in response object
# Status code exists in response object
error_context = None
except requests.exceptions.HTTPError as errh:
error_context = "HTTP Error"
Expand Down Expand Up @@ -159,27 +159,27 @@ def sherlock(username, site_data, query_notify,
there was an HTTP error when checking for existence.
"""

#Notify caller that we are starting the query.
# Notify caller that we are starting the query.
query_notify.start(username)

# Create session based on request methodology
if tor or unique_tor:
#Requests using Tor obfuscation
# Requests using Tor obfuscation
underlying_request = TorRequest()
underlying_session = underlying_request.session
else:
#Normal requests
# Normal requests
underlying_session = requests.session()
underlying_request = requests.Request()

#Limit number of workers to 20.
#This is probably vastly overkill.
# Limit number of workers to 20.
# This is probably vastly overkill.
if len(site_data) >= 20:
max_workers=20
else:
max_workers=len(site_data)

#Create multi-threaded session for all requests.
# Create multi-threaded session for all requests.
session = SherlockFuturesSession(max_workers=max_workers,
session=underlying_session)

Expand Down Expand Up @@ -235,14 +235,14 @@ def sherlock(username, site_data, query_notify,

if (net_info["errorType"] == 'status_code' and
net_info.get("request_head_only", True) == True):
#In most cases when we are detecting by status code,
#it is not necessary to get the entire body: we can
#detect fine with just the HEAD response.
# In most cases when we are detecting by status code,
# it is not necessary to get the entire body: we can
# detect fine with just the HEAD response.
request_method = session.head
else:
#Either this detect method needs the content associated
#with the GET response, or this specific website will
#not respond properly unless we request the whole page.
# Either this detect method needs the content associated
# with the GET response, or this specific website will
# not respond properly unless we request the whole page.
request_method = session.get

if net_info["errorType"] == "response_url":
Expand Down Expand Up @@ -302,7 +302,7 @@ def sherlock(username, site_data, query_notify,
error_type=error_type,
social_network=social_network)

#Get response time for response of our request.
# Get response time for response of our request.
try:
response_time = r.elapsed
except AttributeError:
Expand Down Expand Up @@ -391,12 +391,12 @@ def sherlock(username, site_data, query_notify,
QueryStatus.AVAILABLE,
query_time=response_time)
else:
#It should be impossible to ever get here...
# It should be impossible to ever get here...
raise ValueError(f"Unknown Error Type '{error_type}' for "
f"site '{social_network}'")


#Notify caller about results of query.
# Notify caller about results of query.
query_notify.update(result)

# Save status of request
Expand All @@ -409,7 +409,7 @@ def sherlock(username, site_data, query_notify,
# Add this site's results into final dictionary with all of the other results.
results_total[social_network] = results_site

#Notify caller that all queries are finished.
# Notify caller that all queries are finished.
query_notify.finish()

return results_total
Expand Down Expand Up @@ -559,7 +559,7 @@ def main():
sys.exit(1)


#Create object with all information about sites we are aware of.
# Create object with all information about sites we are aware of.
try:
if args.local:
sites = SitesInformation(os.path.join(os.path.dirname(__file__), 'resources/data.json'))
Expand All @@ -569,9 +569,9 @@ def main():
print(f"ERROR: {error}")
sys.exit(1)

#Create original dictionary from SitesInformation() object.
#Eventually, the rest of the code will be updated to use the new object
#directly, but this will glue the two pieces together.
# Create original dictionary from SitesInformation() object.
# Eventually, the rest of the code will be updated to use the new object
# directly, but this will glue the two pieces together.
site_data_all = {}
for site in sites:
site_data_all[site.name] = site.information
Expand Down Expand Up @@ -601,7 +601,7 @@ def main():
if not site_data:
sys.exit(1)

#Create notify object for query results.
# Create notify object for query results.
query_notify = QueryNotifyPrint(result=None,
verbose=args.verbose,
print_all=args.print_all,
Expand Down
4 changes: 2 additions & 2 deletions sherlock/sites.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ def __init__(self, data_file_path=None):
f"data file URL '{data_file_path}'."
)
else:
#Reference is to a file.
# Reference is to a file.
try:
with open(data_file_path, "r", encoding="utf-8") as file:
try:
Expand All @@ -154,7 +154,7 @@ def __init__(self, data_file_path=None):

self.sites = {}

#Add all of site information from the json file to internal site list.
# Add all of site information from the json file to internal site list.
for site_name in site_data:
try:

Expand Down

0 comments on commit 9d824d1

Please sign in to comment.