An open API service indexing awesome lists of open source software.

https://github.com/kohrongying/codecrafters-redis-python


https://github.com/kohrongying/codecrafters-redis-python

Last synced: about 2 months ago
JSON representation

Awesome Lists containing this project

README

        

This is a starting point for Python solutions to the
["Build Your Own Redis" Challenge](https://codecrafters.io/challenges/redis).

In this challenge, you'll build a toy Redis clone that's capable of handling
basic commands like `PING`, `SET` and `GET`. Along the way we'll learn about
event loops, the Redis protocol and more.

**Note**: If you're viewing this repo on GitHub, head over to
[codecrafters.io](https://codecrafters.io) to signup for early access.

# Passing the first stage

The entry point for your Redis implementation is in `app/main.py`. Study and
uncomment the relevant code, and push your changes to pass the first stage:

```sh
git add .
git commit -m "pass 1st stage" # any msg
git push origin master
```

That's all!

# Stage 2 & beyond

Note: This section is for stages 2 and beyond.

1. Ensure you have `python (3.8)` installed locally
1. Run `./spawn_redis_server.sh` to run your Redis server, which is implemented
in `app/main.py`.
1. Commit your changes and run `git push origin master` to submit your solution
to CodeCrafters. Test output will be streamed to your terminal.

# Troubleshooting

## module `socket` has no attribute `create_server`

When running your server locally, you might see an error like this:

```
Traceback (most recent call last):
File "/.../python3.7/runpy.py", line 193, in _run_module_as_main
"__main__", mod_spec)
File "/.../python3.7/runpy.py", line 85, in _run_code
exec(code, run_globals)
File "/app/app/main.py", line 11, in
main()
File "/app/app/main.py", line 6, in main
s = socket.create_server(("localhost", 6379), reuse_port=True)
AttributeError: module 'socket' has no attribute 'create_server'
```

This is because `socket.create_server` was introduced in Python 3.8, and you
might be running an older version.

You can fix this by installing Python 3.8 locally and using that.

If you'd like to use a different version of Python, change the `language_pack`
value in `codecrafters.yml`.

# Notes

## RESP
In RESP, the first byte determines the data type:

For Simple Strings, the first byte of the reply is "+"
For Errors, the first byte of the reply is "-"
For Integers, the first byte of the reply is ":"
For Bulk Strings, the first byte of the reply is "$"
For Arrays, the first byte of the reply is "*"

`"*2\r\n$4\r\nECHO\r\n$3\r\nhey\r\n"`
- `*2` means RESP Array of 2 elements
- `$` means Bulk String (binary safe string), `$4` Bulk String of 4 bytes