Welcome to Software Development on Codidact!
Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.
Program freezing in `post_comments_to_lemmy` function due to potential infinite loop
I'm experiencing an issue where my program appears to freeze when executing the post_comments_to_lemmy function. This function fetches comments from the GitHub API and posts them to a Lemmy instance. However, it seems that there might be a potential infinite loop within the function that causes the program to hang indefinitely.
I've noticed that the code includes a check within the for loop that skips the iteration if comment_dict is an instance of a string (str). However, if all the comment_dict objects are strings, the loop may continue indefinitely, resulting in the program appearing to freeze.
I'm looking for guidance on how to fix this issue and prevent the program from freezing.
For more context here is the script.
def post_comments_to_lemmy(
lemmy: Any, post_id: int, github_repo: str, issue: Issue
) -> None:
logging.info(
f"Posting comments from issue #{issue.number} to Lemmy post {LEMMY_INSTANCE_URL}/post/{post_id}"
)
try:
comments_url: str = (
f"{GITHUB_API_BASE}/repos/{github_repo}/issues/{issue.number}/comments"
)
comments: list[dict[str, Any]] = fetch_github_data(comments_url)
for comment_dict in comments:
if isinstance(comment_dict, str):
continue
comment = Comment(comment_dict, issue.number)
post_comment_to_lemmy(lemmy, github_repo, comment, post_id, issue.number)
except Exception as e:
logging.exception(f"Error posting comments to lemmy post {post_id}\n{e}")
raise
def fetch_github_data(url):
try:
headers = {"Accept": "application/vnd.github+json"}
response = requests.get(url, headers=headers)
response.raise_for_status()
time.sleep(DELAY)
logging.info(f"Fetched data from {url}")
return response.json()
except requests.exceptions.RequestException as e:
logging.exception(f"Error fetching data from {url}\n{e}")
raise
[INFO]:2023-07-14 10:40:46,748:root [github_lemmy_issue_reposter.py:275 - post_comments_to_lemmy()] Posting comments from issue #1889 to Lemmy post https://lemm.ee/post/1111239
[INFO]:2023-07-14 10:40:48,035:root [github_lemmy_issue_reposter.py:93 - fetch_github_data()] Fetched data from https://api.github.com/repos/LemmyNet/lemmy-ui/issues/1889/comments
1 answer
There is no infinite loop. If the dictionary is a string, it is simply skipped. If all dictionaries are strings, than all elements of the finite list are skipped, and the function returns without posting anything.
So either the program hangs in the post_comment_to_lemmy() function, that we don't see in the question. Or you are misinterpreting no log output or no posted comments from that function as hanging.
Some things in the first paragraph may sound strange — because the type annotations are incorrect. Or the code is. comments is annotated to be a list of dictionaries. The code then tests the list elements if they are instances of str — which doesn't make sense because the annotation says there's just dictionaries at that level.
Type annotations make sense only if they are correct. Wrong type annotations are worse than no annotations at all.
0 comment threads
1 comment thread