Prompting the User for Input

Oct 13, 2025 by miodeya.com 69 views

Introduction

In this task, we will focus on creating a user-friendly interface for creating intersections. We will implement a method called get_intersection_input that will gather input from the user and create a dictionary of Intersection objects. This dictionary will store the created intersections, along with their respective IDs and connected roads.

Creating the `entrypoints/cli/main.py` File

To finalize the project, we need to create an entrypoints/cli/main.py file. This file will serve as the entry point for our command-line interface (CLI). It will contain the main function that will be responsible for executing the program.

# entrypoints/cli/main.py

import argparse
from intersection import get_intersection_input

def main():
    parser = argparse.ArgumentParser(description='Create intersections')
    parser.add_argument('--num_intersections', type=int, help='Number of intersections to create')
    args = parser.parse_args()

    if args.num_intersections:
        intersections = get_intersection_input(args.num_intersections)
        print(intersections)
    else:
        print('Please provide the number of intersections to create')

if __name__ == '__main__':
    main()

Implementing the `get_intersection_input` Method

The get_intersection_input method will be responsible for gathering input from the user and creating a dictionary of Intersection objects. Here's how we can implement it:

# intersection.py

from typing import Dict

class Intersection:
    def __init__(self, id: str, connected_roads: str):
        self.id = id
        self.connected_roads = connected_roads

def get_intersection_input(num_intersections: int) -> Dict[str, Intersection]:
    intersections = {}

    for i in range(num_intersections):
        id = input(f'Enter ID for intersection {i+1}: ')
        connected_roads = input(f'Enter connected roads for intersection {id} (comma-separated): ')

        intersection = Intersection(id, connected_roads)
        intersections[id] = intersection

    return intersections

Prompting the User for Input

In the get_intersection_input method, we will prompt the user for the number of intersections to be created and store it in a variable. We will then loop through the number of intersections and prompt the user to enter an ID for the intersection and the connected roads (comma-separated). We will store the ID and connected roads in a dictionary where the key is the intersection ID and the value is an Intersection object.

# intersection.py

def get_intersection_input(num_intersections: int) -> Dict[str, Intersection]:
    intersections = {}

    for i in range(num_intersections):
        id = input(f'Enter ID for intersection {i+1}: ')
        connected_roads = input(f'Enter connected roads for intersection {id} (comma-separated): ')

        intersection = Intersection(id, connected_roads)
        intersections[id] = intersection

    return intersections

Implementing Unit Tests

We will use pytest to implement unit tests for the get_intersection_input function. We will test the function with different inputs to ensure it behaves as expected.

# test_intersection.py

import pytest
from intersection import get_intersection_input

def test_get_intersection_input():
    num_intersections = 2
    intersections = get_intersection_input(num_intersections)

    assert len(intersections) == num_intersections

def test_get_intersection_input_id():
    num_intersections = 1
    intersections = get_intersection_input(num_intersections)

    assert intersections['intersection1'].id == 'intersection1'

def test_get_intersection_input_connected_roads():
    num_intersections = 1
    intersections = get_intersection_input(num_intersections)

    assert intersections['intersection1'].connected_roads == 'road1,road2'

Conclusion

Introduction

In our previous task, we implemented a user-friendly interface for creating intersections. We created a get_intersection_input method that gathers input from the user and creates a dictionary of Intersection objects. In this Q&A article, we will answer some common questions related to the implementation of the get_intersection_input method.

Q: What is the purpose of the `get_intersection_input` method?

A: The get_intersection_input method is responsible for gathering input from the user and creating a dictionary of Intersection objects. This dictionary stores the created intersections, along with their respective IDs and connected roads.

Q: How does the `get_intersection_input` method work?

A: The get_intersection_input method prompts the user for the number of intersections to be created and stores it in a variable. It then loops through the number of intersections and prompts the user to enter an ID for the intersection and the connected roads (comma-separated). The ID and connected roads are stored in a dictionary where the key is the intersection ID and the value is an Intersection object.

Q: What is the `Intersection` class?

A: The Intersection class is a Python class that represents an intersection. It has two attributes: id and connected_roads. The id attribute stores the ID of the intersection, and the connected_roads attribute stores the connected roads of the intersection.

Q: How do I implement unit tests for the `get_intersection_input` method?

A: You can implement unit tests for the get_intersection_input method using pytest. You can write test cases to test the function with different inputs to ensure it behaves as expected.

Q: What are some common edge cases to test for the `get_intersection_input` method?

A: Some common edge cases to test for the get_intersection_input method include:

Testing with an empty input for the number of intersections
Testing with a negative input for the number of intersections
Testing with a non-integer input for the number of intersections
Testing with an empty input for the ID of the intersection
Testing with a non-string input for the connected roads of the intersection

Q: How do I handle invalid input for the `get_intersection_input` method?

A: You can handle invalid input for the get_intersection_input method by using try-except blocks to catch any exceptions that may occur. You can also use regular expressions to validate the input and ensure it conforms to the expected format.

Q: What are some best practices for implementing the `get_intersection_input` method?

A: Some best practices for implementing the get_intersection_input method include:

Using clear and concise variable names
Using comments to explain the purpose of the code
Using functions to break down the code into smaller, more manageable pieces
Using unit tests to ensure the function behaves as expected
Using a consistent coding style throughout the code

Conclusion

In this Q&A article, we answered some common questions related to the implementation of the get_intersection_input method. We covered topics such as the purpose of the method, how it works, and how to implement unit tests. We also discussed some common edge cases to test for and how to handle invalid input. Finally, we provided some best practices for implementing the get_intersection_input method.