Skip to content

Commit 86da9cd

Browse files
authored
socha: update v1.0.1
* penguins: add a coordinate super class * penguins: add a TeamEnum enumeration class * penguins: add the team_enum attribute to Move * penguins: add a Penguin class * penguins: add penguin and fish attribute to the Field class * penguins: rename remove color and add name, fish, penguins, moves attributes in the Team class * penguins: remade pretty_print for a more concise look * penguins: adapt methods of Board * penguins: make _move public * penguins: fix an issue with move that it no longer changes the original board * penguins: remove the fish class, because the fish count is now tract in the Team class * penguins: add fist_team, second_team attribute. remove fish attribute * penguins: adept the methods of GameState to the new classes * network_socket: rework class * xml_protocol_interface: rework of the class * starter: add auto-reconnect feature * game_client: rework of GameClient * . * __init__: adjust imports to refactor * penguins.py: rename variables * penguins: move opponent from Team to GameState * penguins: redone get_teams_penguins which returns List[Penguin] now * penguins: add hex align feature to pretty_print * penguins: redone __eq__ of Board * penguins: fix a problem with _get_possible_moves * penguins: fix a problem with current_team_from_turn * penguins: fix a problem with perform_move * LICENSE: change license to MIT * penguin: add static to opponent * tests: reimplement unit tests * socha: fix several issues that caused crashes * game_client: extend history list * auto-reconnect: fix a problem where it won't connect to the server * penguin: fix several issues that prevented the correct simulation and storing of game states * xml_protocol_interface: fix an issue where the protocol tag doesn't get sent if auto reconnect * tests: fix issues in test * changes: add a doc that lists all changes from previous version * socha: bump version to 1.0.1 * network_socket: fix an issue where the client doesn't reconnect with auto-reconnect * game_client: add some logging * starter: change link to master
1 parent f910d21 commit 86da9cd

File tree

13 files changed

+1313
-1026
lines changed

13 files changed

+1313
-1026
lines changed

LICENSE

Lines changed: 21 additions & 165 deletions
Original file line numberDiff line numberDiff line change
@@ -1,165 +1,21 @@
1-
GNU LESSER GENERAL PUBLIC LICENSE
2-
Version 3, 29 June 2007
3-
4-
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
5-
Everyone is permitted to copy and distribute verbatim copies
6-
of this license document, but changing it is not allowed.
7-
8-
9-
This version of the GNU Lesser General Public License incorporates
10-
the terms and conditions of version 3 of the GNU General Public
11-
License, supplemented by the additional permissions listed below.
12-
13-
0. Additional Definitions.
14-
15-
As used herein, "this License" refers to version 3 of the GNU Lesser
16-
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17-
General Public License.
18-
19-
"The Library" refers to a covered work governed by this License,
20-
other than an Application or a Combined Work as defined below.
21-
22-
An "Application" is any work that makes use of an interface provided
23-
by the Library, but which is not otherwise based on the Library.
24-
Defining a subclass of a class defined by the Library is deemed a mode
25-
of using an interface provided by the Library.
26-
27-
A "Combined Work" is a work produced by combining or linking an
28-
Application with the Library. The particular version of the Library
29-
with which the Combined Work was made is also called the "Linked
30-
Version".
31-
32-
The "Minimal Corresponding Source" for a Combined Work means the
33-
Corresponding Source for the Combined Work, excluding any source code
34-
for portions of the Combined Work that, considered in isolation, are
35-
based on the Application, and not on the Linked Version.
36-
37-
The "Corresponding Application Code" for a Combined Work means the
38-
object code and/or source code for the Application, including any data
39-
and utility programs needed for reproducing the Combined Work from the
40-
Application, but excluding the System Libraries of the Combined Work.
41-
42-
1. Exception to Section 3 of the GNU GPL.
43-
44-
You may convey a covered work under sections 3 and 4 of this License
45-
without being bound by section 3 of the GNU GPL.
46-
47-
2. Conveying Modified Versions.
48-
49-
If you modify a copy of the Library, and, in your modifications, a
50-
facility refers to a function or data to be supplied by an Application
51-
that uses the facility (other than as an argument passed when the
52-
facility is invoked), then you may convey a copy of the modified
53-
version:
54-
55-
a) under this License, provided that you make a good faith effort to
56-
ensure that, in the event an Application does not supply the
57-
function or data, the facility still operates, and performs
58-
whatever part of its purpose remains meaningful, or
59-
60-
b) under the GNU GPL, with none of the additional permissions of
61-
this License applicable to that copy.
62-
63-
3. Object Code Incorporating Material from Library Header Files.
64-
65-
The object code form of an Application may incorporate material from
66-
a header file that is part of the Library. You may convey such object
67-
code under terms of your choice, provided that, if the incorporated
68-
material is not limited to numerical parameters, data structure
69-
layouts and accessors, or small macros, inline functions and templates
70-
(ten or fewer lines in length), you do both of the following:
71-
72-
a) Give prominent notice with each copy of the object code that the
73-
Library is used in it and that the Library and its use are
74-
covered by this License.
75-
76-
b) Accompany the object code with a copy of the GNU GPL and this license
77-
document.
78-
79-
4. Combined Works.
80-
81-
You may convey a Combined Work under terms of your choice that,
82-
taken together, effectively do not restrict modification of the
83-
portions of the Library contained in the Combined Work and reverse
84-
engineering for debugging such modifications, if you also do each of
85-
the following:
86-
87-
a) Give prominent notice with each copy of the Combined Work that
88-
the Library is used in it and that the Library and its use are
89-
covered by this License.
90-
91-
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92-
document.
93-
94-
c) For a Combined Work that displays copyright notices during
95-
execution, include the copyright notice for the Library among
96-
these notices, as well as a reference directing the user to the
97-
copies of the GNU GPL and this license document.
98-
99-
d) Do one of the following:
100-
101-
0) Convey the Minimal Corresponding Source under the terms of this
102-
License, and the Corresponding Application Code in a form
103-
suitable for, and under terms that permit, the user to
104-
recombine or relink the Application with a modified version of
105-
the Linked Version to produce a modified Combined Work, in the
106-
manner specified by section 6 of the GNU GPL for conveying
107-
Corresponding Source.
108-
109-
1) Use a suitable shared library mechanism for linking with the
110-
Library. A suitable mechanism is one that (a) uses at run time
111-
a copy of the Library already present on the user's computer
112-
system, and (b) will operate properly with a modified version
113-
of the Library that is interface-compatible with the Linked
114-
Version.
115-
116-
e) Provide Installation Information, but only if you would otherwise
117-
be required to provide such information under section 6 of the
118-
GNU GPL, and only to the extent that such information is
119-
necessary to install and execute a modified version of the
120-
Combined Work produced by recombining or relinking the
121-
Application with a modified version of the Linked Version. (If
122-
you use option 4d0, the Installation Information must accompany
123-
the Minimal Corresponding Source and Corresponding Application
124-
Code. If you use option 4d1, you must provide the Installation
125-
Information in the manner specified by section 6 of the GNU GPL
126-
for conveying Corresponding Source.)
127-
128-
5. Combined Libraries.
129-
130-
You may place library facilities that are a work based on the
131-
Library side by side in a single library together with other library
132-
facilities that are not Applications and are not covered by this
133-
License, and convey such a combined library under terms of your
134-
choice, if you do both of the following:
135-
136-
a) Accompany the combined library with a copy of the same work based
137-
on the Library, uncombined with any other library facilities,
138-
conveyed under the terms of this License.
139-
140-
b) Give prominent notice with the combined library that part of it
141-
is a work based on the Library, and explaining where to find the
142-
accompanying uncombined form of the same work.
143-
144-
6. Revised Versions of the GNU Lesser General Public License.
145-
146-
The Free Software Foundation may publish revised and/or new versions
147-
of the GNU Lesser General Public License from time to time. Such new
148-
versions will be similar in spirit to the present version, but may
149-
differ in detail to address new problems or concerns.
150-
151-
Each version is given a distinguishing version number. If the
152-
Library as you received it specifies that a certain numbered version
153-
of the GNU Lesser General Public License "or any later version"
154-
applies to it, you have the option of following the terms and
155-
conditions either of that published version or of any later version
156-
published by the Free Software Foundation. If the Library as you
157-
received it does not specify a version number of the GNU Lesser
158-
General Public License, you may choose any version of the GNU Lesser
159-
General Public License ever published by the Free Software Foundation.
160-
161-
If the Library as you received it specifies that a proxy can decide
162-
whether future versions of the GNU Lesser General Public License shall
163-
apply, that proxy's public statement of acceptance of any version is
164-
permanent authorization for you to choose that version for the
165-
Library.
1+
MIT License
2+
3+
Copyright (c) 2023 FalconsSky
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

changes.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# `GameState`
2+
3+
4+
- Die Signatur hat sich geändert:
5+
- `def __init__(self, board: Board, turn: int, start_team: Team, fishes: Fishes, last_move: Move = None)`
6+
- `def __init__(self, board: Board, turn: int, first_team: Team, second_team: Team, last_move: Optional[Move])`
7+
## `fishes`
8+
- Das Attribut wurde entfernt. Die Anzahl an Fischen eines Teams kann nun in dem Team-Objekt selbst gefunden werden:
9+
- z.B.: `self.game_state.first_team.fish`
10+
11+
# `TeamEnum`
12+
Diese Klasse ist lediglich eine Enumeration der beiden Strings `ONE` und `TWO`. Sie dient den folgenden Klassen,
13+
das Team zu unterscheiden und das Handhaben mit den Strings eleganter zu gestalten.
14+
15+
# `Move`
16+
17+
- Die Signatur hat sich geändert:
18+
- `def __init__(self, to_value: HexCoordinate, from_value: HexCoordinate = None)`
19+
- `def __init__(self, team_enum: TeamEnum, to_value: HexCoordinate, from_value: Optional[HexCoordinate])`
20+
21+
# `Team`
22+
23+
- Die Signatur hat sich geändert:
24+
- `def __init__(self, color: str)`
25+
- `def __init__(self, name: TeamEnum, fish: int, penguins: List[Penguin], moves: List[Move])`
26+
27+
Dies dient dazu, die Struktur und Relationen der Klassen sinnvoller zu gestalten.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
44

55
[project]
66
name = "socha"
7-
version = "1.0.0"
7+
version = "1.0.1"
88
authors = [
99
{ name = "FalconsSky", email = "stu222782@mail.uni-kiel.de" },
1010
]

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
setup(
77
name='socha',
8-
version='1.0.0',
8+
version='1.0.1',
99
packages=['socha', 'socha.api', 'socha.api.plugin', 'socha.api.protocol',
1010
'socha.api.networking'],
1111
url='https://github.com/FalconsSky/Software-Challenge-Python-Client',

socha/__init__.py

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,21 @@
1-
from socha.api.networking.player_client import IClientHandler
1+
from socha.api.networking.game_client import IClientHandler
22
from socha.api.plugin.penguins import *
33
from socha.api.protocol.protocol import Result
44
from socha.starter import Starter
55

66
__all__ = [
7-
'IClientHandler',
8-
'Starter',
9-
'Vector',
7+
'Board',
108
'CartesianCoordinate',
11-
'HexCoordinate',
12-
'Move',
13-
'Team',
9+
'Coordinate',
1410
'Field',
15-
'Board',
16-
'Fishes',
1711
'GameState',
12+
'HexCoordinate',
13+
'IClientHandler',
14+
'Move',
15+
'Penguin',
1816
'Result',
17+
'Starter',
18+
'Team',
19+
'TeamEnum',
20+
'Vector',
1921
]

socha/api/networking/_network_interface.py

Lines changed: 0 additions & 92 deletions
This file was deleted.

0 commit comments

Comments
 (0)