This is the first part of the AirBnB clone project where we worked on the backend of the project whiles interfacing it with a console application with the help of the cmd module in python.
Data (python objects) generated are stored in a json file and can be accessed using json module in python
This command line interpreter serves as the frontend of the web app where users can interact with the backend which was developed with python OOP programming.
As part of the implementation of the command line interpreter, the folowing actions can be performed:
- Creating new objects (ex: a new User or a new Place)
- Retrieving an object from a file, a database etc…
- Doing operations on objects (count, compute stats, etc…)
- Updating attributes of an object
- Destroying an object
- Clone the repository of the project from Github. This will contain the simple shell program and all of its dependencies.
[git clone https://github.com/jzamora5/AirBnB_clone.git
](https://github.com/MennaAnwar/AirBnB_clone.git)
- After cloning the repository, there is a folder called AirBnB_clone with several files necessary for program to work.
/console.py : The main executable of the project, the command interpreter.
models/engine/file_storage.py: Class that serializes instances to a JSON file and deserializes JSON file to instances
models/__ init __.py: A unique
FileStorageinstance for the applicationmodels/base_model.py: Class that defines all common attributes/methods for other classes.
models/user.py: User class that inherits from BaseModel
models/state.py: State class that inherits from BaseModel
models/city.py: City class that inherits from BaseModel
models/amenity.py: Amenity class that inherits from BaseModel
models/place.py: Place class that inherits from BaseModel
models/review.py: Review class that inherits from BaseModel
It can work in two different modes:
Interactive and Non-interactive.
In Interactive mode, the console will display a prompt (hbnb) indicating that the user can interact with the prompt.
$ ./console.py
(hbnb) help
Documented commands (type help <topic>):
========================================
EOF help quit
(hbnb)
(hbnb)
(hbnb) quit
$
In Non-interactive mode ((like the Shell project in C)), the shell will need to be run with a command input piped into its execution so that the command is run as soon as the Shell starts. In this mode no prompt will appear, and no further input will be expected from the user.
$ echo "help" | ./console.py
(hbnb)
Documented commands (type help <topic>):
========================================
EOF help quit
(hbnb)
$
$ cat test_help
help
$
$ cat test_help | ./console.py
(hbnb)
Documented commands (type help <topic>):
========================================
EOF help quit
(hbnb)
$
- create:
Creates a new instance of a given class. The class' ID is printed and the instance is saved to the file file.json.
(hbnb) create BaseModel
49faff9a-6318-451f-87b6-910505c55907
- show:
Prints the string representation of a class instance based on a given id.
(hbnb) show BaseModel 49faff9a-6318-451f-87b6-910505c55907
[BaseModel] (49faff9a-6318-451f-87b6-910505c55907) {'created_at': datetime.datetime(2017, 10, 2, 3, 10, 25, 903293), 'id': '49faff9a-6318-451f-87b6-910505c55907', 'updated_at': datetime.datetime(2017, 10, 2, 3, 10, 25, 903300)}
- Muhammad Hany