akinator-py 0.2.1

Python bindings for akinator-rs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145


Examples
=========

**Installation**

wheels are prebuilt and uploaded to pypi, so if your platform is supported, simply doing

.. code-block:: shell

    $ py -m pip install akinator.py

will do it

You can also manually build from source, but that requires rust to be installed.

**importing**

.. code-block:: python

    import akinator

**Full sync example**

Here is a full working example of using the sync akinator class

.. code-block:: python

    from akinator import (
        CantGoBackAnyFurther,
        InvalidAnswer,
        Akinator,
        Answer,
        Theme,
    )

    def test() -> None:
        # create akinator instance
        aki = Akinator(
            child_mode=True,
            theme=Theme.from_str('characters'),
        )

        # start the game, and get the first question
        first_question = aki.start_game()
        # recieve console input for first question
        answer = input(f'{first_question}: ')

        # keep asking and recieving answers while akinator's progression is <=80
        while aki.progression <= 80:
            if answer == 'back':
                # go back a question if response is "back"
                try:
                    aki.back()
                    print('went back 1 question')
                except CantGoBackAnyFurther:
                    print('cannot go back any further!')
            else:
                try:
                    # parse to an answer enum variant
                    answer = Answer.from_str(answer)
                except InvalidAnswer:
                    print('Invalid answer')
                else:
                    # answer current question
                    aki.answer(answer)

            # recieving console input for next question
            answer = input(f'{aki.question}: ')

        # tell akinator to end the game and make its guess
        first_guess = aki.win()

        if first_guess:
            # print out its first guess's details
            print('name:', first_guess.name)
            print('desc:', first_guess.description)
            print('image:', first_guess.absolute_picture_path)

    if __name__ == '__main__':
        test()

**Full async example**

Here is a full working example of using the async akinator class with ``asyncio``

(pretty much the same except all methods are awaited)

.. code-block:: python

    import asyncio

    from akinator import (
        CantGoBackAnyFurther,
        InvalidAnswer,
        AsyncAkinator,
        Answer,
        Theme,
    )

    async def test() -> None:
        # create akinator instance
        aki = AsyncAkinator(
            child_mode=True,
            theme=Theme.from_str('characters'),
        )

        # start the game, and get the first question
        first_question = await aki.start_game()
        # recieve console input for first question
        answer = input(f'{first_question}: ')

        # keep asking and recieving answers while akinator's progression is <=80
        while aki.progression <= 80:
            if answer == 'back':
                # go back a question if response is "back"
                try:
                    await aki.back()
                    print('went back 1 question')
                except CantGoBackAnyFurther:
                    print('cannot go back any further!')
            else:
                try:
                    # parse to an answer enum variant
                    answer = Answer.from_str(answer)
                except InvalidAnswer:
                    print('Invalid answer')
                else:
                    # answer current question
                    await aki.answer(answer)

            # recieving console input for next question
            answer = input(f'{aki.question}: ')

        # tell akinator to end the game and make its guess
        first_guess = await aki.win()

        if first_guess:
            # print out its first guess's details
            print('name:', first_guess.name)
            print('desc:', first_guess.description)
            print('image:', first_guess.absolute_picture_path)

    if __name__ == '__main__':
        asyncio.run(test())