├── .gitignore ├── LICENSE ├── README.md ├── factorio_rcon ├── __init__.py ├── _impl.py └── py.typed └── pyproject.toml /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__/ 2 | .vscode/ 3 | build/ 4 | dist/ 5 | *.egg-info/ -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 2.1, February 1999 3 | 4 | Copyright (C) 1991, 1999 Free Software Foundation, Inc. 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | [This is the first released version of the Lesser GPL. It also counts 10 | as the successor of the GNU Library Public License, version 2, hence 11 | the version number 2.1.] 12 | 13 | Preamble 14 | 15 | The licenses for most software are designed to take away your 16 | freedom to share and change it. By contrast, the GNU General Public 17 | Licenses are intended to guarantee your freedom to share and change 18 | free software--to make sure the software is free for all its users. 19 | 20 | This license, the Lesser General Public License, applies to some 21 | specially designated software packages--typically libraries--of the 22 | Free Software Foundation and other authors who decide to use it. You 23 | can use it too, but we suggest you first think carefully about whether 24 | this license or the ordinary General Public License is the better 25 | strategy to use in any particular case, based on the explanations below. 26 | 27 | When we speak of free software, we are referring to freedom of use, 28 | not price. Our General Public Licenses are designed to make sure that 29 | you have the freedom to distribute copies of free software (and charge 30 | for this service if you wish); that you receive source code or can get 31 | it if you want it; that you can change the software and use pieces of 32 | it in new free programs; and that you are informed that you can do 33 | these things. 34 | 35 | To protect your rights, we need to make restrictions that forbid 36 | distributors to deny you these rights or to ask you to surrender these 37 | rights. These restrictions translate to certain responsibilities for 38 | you if you distribute copies of the library or if you modify it. 39 | 40 | For example, if you distribute copies of the library, whether gratis 41 | or for a fee, you must give the recipients all the rights that we gave 42 | you. You must make sure that they, too, receive or can get the source 43 | code. If you link other code with the library, you must provide 44 | complete object files to the recipients, so that they can relink them 45 | with the library after making changes to the library and recompiling 46 | it. And you must show them these terms so they know their rights. 47 | 48 | We protect your rights with a two-step method: (1) we copyright the 49 | library, and (2) we offer you this license, which gives you legal 50 | permission to copy, distribute and/or modify the library. 51 | 52 | To protect each distributor, we want to make it very clear that 53 | there is no warranty for the free library. Also, if the library is 54 | modified by someone else and passed on, the recipients should know 55 | that what they have is not the original version, so that the original 56 | author's reputation will not be affected by problems that might be 57 | introduced by others. 58 | 59 | Finally, software patents pose a constant threat to the existence of 60 | any free program. We wish to make sure that a company cannot 61 | effectively restrict the users of a free program by obtaining a 62 | restrictive license from a patent holder. Therefore, we insist that 63 | any patent license obtained for a version of the library must be 64 | consistent with the full freedom of use specified in this license. 65 | 66 | Most GNU software, including some libraries, is covered by the 67 | ordinary GNU General Public License. This license, the GNU Lesser 68 | General Public License, applies to certain designated libraries, and 69 | is quite different from the ordinary General Public License. We use 70 | this license for certain libraries in order to permit linking those 71 | libraries into non-free programs. 72 | 73 | When a program is linked with a library, whether statically or using 74 | a shared library, the combination of the two is legally speaking a 75 | combined work, a derivative of the original library. The ordinary 76 | General Public License therefore permits such linking only if the 77 | entire combination fits its criteria of freedom. The Lesser General 78 | Public License permits more lax criteria for linking other code with 79 | the library. 80 | 81 | We call this license the "Lesser" General Public License because it 82 | does Less to protect the user's freedom than the ordinary General 83 | Public License. It also provides other free software developers Less 84 | of an advantage over competing non-free programs. These disadvantages 85 | are the reason we use the ordinary General Public License for many 86 | libraries. However, the Lesser license provides advantages in certain 87 | special circumstances. 88 | 89 | For example, on rare occasions, there may be a special need to 90 | encourage the widest possible use of a certain library, so that it becomes 91 | a de-facto standard. To achieve this, non-free programs must be 92 | allowed to use the library. A more frequent case is that a free 93 | library does the same job as widely used non-free libraries. In this 94 | case, there is little to gain by limiting the free library to free 95 | software only, so we use the Lesser General Public License. 96 | 97 | In other cases, permission to use a particular library in non-free 98 | programs enables a greater number of people to use a large body of 99 | free software. For example, permission to use the GNU C Library in 100 | non-free programs enables many more people to use the whole GNU 101 | operating system, as well as its variant, the GNU/Linux operating 102 | system. 103 | 104 | Although the Lesser General Public License is Less protective of the 105 | users' freedom, it does ensure that the user of a program that is 106 | linked with the Library has the freedom and the wherewithal to run 107 | that program using a modified version of the Library. 108 | 109 | The precise terms and conditions for copying, distribution and 110 | modification follow. Pay close attention to the difference between a 111 | "work based on the library" and a "work that uses the library". The 112 | former contains code derived from the library, whereas the latter must 113 | be combined with the library in order to run. 114 | 115 | GNU LESSER GENERAL PUBLIC LICENSE 116 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 117 | 118 | 0. This License Agreement applies to any software library or other 119 | program which contains a notice placed by the copyright holder or 120 | other authorized party saying it may be distributed under the terms of 121 | this Lesser General Public License (also called "this License"). 122 | Each licensee is addressed as "you". 123 | 124 | A "library" means a collection of software functions and/or data 125 | prepared so as to be conveniently linked with application programs 126 | (which use some of those functions and data) to form executables. 127 | 128 | The "Library", below, refers to any such software library or work 129 | which has been distributed under these terms. A "work based on the 130 | Library" means either the Library or any derivative work under 131 | copyright law: that is to say, a work containing the Library or a 132 | portion of it, either verbatim or with modifications and/or translated 133 | straightforwardly into another language. (Hereinafter, translation is 134 | included without limitation in the term "modification".) 135 | 136 | "Source code" for a work means the preferred form of the work for 137 | making modifications to it. For a library, complete source code means 138 | all the source code for all modules it contains, plus any associated 139 | interface definition files, plus the scripts used to control compilation 140 | and installation of the library. 141 | 142 | Activities other than copying, distribution and modification are not 143 | covered by this License; they are outside its scope. The act of 144 | running a program using the Library is not restricted, and output from 145 | such a program is covered only if its contents constitute a work based 146 | on the Library (independent of the use of the Library in a tool for 147 | writing it). Whether that is true depends on what the Library does 148 | and what the program that uses the Library does. 149 | 150 | 1. You may copy and distribute verbatim copies of the Library's 151 | complete source code as you receive it, in any medium, provided that 152 | you conspicuously and appropriately publish on each copy an 153 | appropriate copyright notice and disclaimer of warranty; keep intact 154 | all the notices that refer to this License and to the absence of any 155 | warranty; and distribute a copy of this License along with the 156 | Library. 157 | 158 | You may charge a fee for the physical act of transferring a copy, 159 | and you may at your option offer warranty protection in exchange for a 160 | fee. 161 | 162 | 2. You may modify your copy or copies of the Library or any portion 163 | of it, thus forming a work based on the Library, and copy and 164 | distribute such modifications or work under the terms of Section 1 165 | above, provided that you also meet all of these conditions: 166 | 167 | a) The modified work must itself be a software library. 168 | 169 | b) You must cause the files modified to carry prominent notices 170 | stating that you changed the files and the date of any change. 171 | 172 | c) You must cause the whole of the work to be licensed at no 173 | charge to all third parties under the terms of this License. 174 | 175 | d) If a facility in the modified Library refers to a function or a 176 | table of data to be supplied by an application program that uses 177 | the facility, other than as an argument passed when the facility 178 | is invoked, then you must make a good faith effort to ensure that, 179 | in the event an application does not supply such function or 180 | table, the facility still operates, and performs whatever part of 181 | its purpose remains meaningful. 182 | 183 | (For example, a function in a library to compute square roots has 184 | a purpose that is entirely well-defined independent of the 185 | application. Therefore, Subsection 2d requires that any 186 | application-supplied function or table used by this function must 187 | be optional: if the application does not supply it, the square 188 | root function must still compute square roots.) 189 | 190 | These requirements apply to the modified work as a whole. If 191 | identifiable sections of that work are not derived from the Library, 192 | and can be reasonably considered independent and separate works in 193 | themselves, then this License, and its terms, do not apply to those 194 | sections when you distribute them as separate works. But when you 195 | distribute the same sections as part of a whole which is a work based 196 | on the Library, the distribution of the whole must be on the terms of 197 | this License, whose permissions for other licensees extend to the 198 | entire whole, and thus to each and every part regardless of who wrote 199 | it. 200 | 201 | Thus, it is not the intent of this section to claim rights or contest 202 | your rights to work written entirely by you; rather, the intent is to 203 | exercise the right to control the distribution of derivative or 204 | collective works based on the Library. 205 | 206 | In addition, mere aggregation of another work not based on the Library 207 | with the Library (or with a work based on the Library) on a volume of 208 | a storage or distribution medium does not bring the other work under 209 | the scope of this License. 210 | 211 | 3. You may opt to apply the terms of the ordinary GNU General Public 212 | License instead of this License to a given copy of the Library. To do 213 | this, you must alter all the notices that refer to this License, so 214 | that they refer to the ordinary GNU General Public License, version 2, 215 | instead of to this License. (If a newer version than version 2 of the 216 | ordinary GNU General Public License has appeared, then you can specify 217 | that version instead if you wish.) Do not make any other change in 218 | these notices. 219 | 220 | Once this change is made in a given copy, it is irreversible for 221 | that copy, so the ordinary GNU General Public License applies to all 222 | subsequent copies and derivative works made from that copy. 223 | 224 | This option is useful when you wish to copy part of the code of 225 | the Library into a program that is not a library. 226 | 227 | 4. You may copy and distribute the Library (or a portion or 228 | derivative of it, under Section 2) in object code or executable form 229 | under the terms of Sections 1 and 2 above provided that you accompany 230 | it with the complete corresponding machine-readable source code, which 231 | must be distributed under the terms of Sections 1 and 2 above on a 232 | medium customarily used for software interchange. 233 | 234 | If distribution of object code is made by offering access to copy 235 | from a designated place, then offering equivalent access to copy the 236 | source code from the same place satisfies the requirement to 237 | distribute the source code, even though third parties are not 238 | compelled to copy the source along with the object code. 239 | 240 | 5. A program that contains no derivative of any portion of the 241 | Library, but is designed to work with the Library by being compiled or 242 | linked with it, is called a "work that uses the Library". Such a 243 | work, in isolation, is not a derivative work of the Library, and 244 | therefore falls outside the scope of this License. 245 | 246 | However, linking a "work that uses the Library" with the Library 247 | creates an executable that is a derivative of the Library (because it 248 | contains portions of the Library), rather than a "work that uses the 249 | library". The executable is therefore covered by this License. 250 | Section 6 states terms for distribution of such executables. 251 | 252 | When a "work that uses the Library" uses material from a header file 253 | that is part of the Library, the object code for the work may be a 254 | derivative work of the Library even though the source code is not. 255 | Whether this is true is especially significant if the work can be 256 | linked without the Library, or if the work is itself a library. The 257 | threshold for this to be true is not precisely defined by law. 258 | 259 | If such an object file uses only numerical parameters, data 260 | structure layouts and accessors, and small macros and small inline 261 | functions (ten lines or less in length), then the use of the object 262 | file is unrestricted, regardless of whether it is legally a derivative 263 | work. (Executables containing this object code plus portions of the 264 | Library will still fall under Section 6.) 265 | 266 | Otherwise, if the work is a derivative of the Library, you may 267 | distribute the object code for the work under the terms of Section 6. 268 | Any executables containing that work also fall under Section 6, 269 | whether or not they are linked directly with the Library itself. 270 | 271 | 6. As an exception to the Sections above, you may also combine or 272 | link a "work that uses the Library" with the Library to produce a 273 | work containing portions of the Library, and distribute that work 274 | under terms of your choice, provided that the terms permit 275 | modification of the work for the customer's own use and reverse 276 | engineering for debugging such modifications. 277 | 278 | You must give prominent notice with each copy of the work that the 279 | Library is used in it and that the Library and its use are covered by 280 | this License. You must supply a copy of this License. If the work 281 | during execution displays copyright notices, you must include the 282 | copyright notice for the Library among them, as well as a reference 283 | directing the user to the copy of this License. Also, you must do one 284 | of these things: 285 | 286 | a) Accompany the work with the complete corresponding 287 | machine-readable source code for the Library including whatever 288 | changes were used in the work (which must be distributed under 289 | Sections 1 and 2 above); and, if the work is an executable linked 290 | with the Library, with the complete machine-readable "work that 291 | uses the Library", as object code and/or source code, so that the 292 | user can modify the Library and then relink to produce a modified 293 | executable containing the modified Library. (It is understood 294 | that the user who changes the contents of definitions files in the 295 | Library will not necessarily be able to recompile the application 296 | to use the modified definitions.) 297 | 298 | b) Use a suitable shared library mechanism for linking with the 299 | Library. A suitable mechanism is one that (1) uses at run time a 300 | copy of the library already present on the user's computer system, 301 | rather than copying library functions into the executable, and (2) 302 | will operate properly with a modified version of the library, if 303 | the user installs one, as long as the modified version is 304 | interface-compatible with the version that the work was made with. 305 | 306 | c) Accompany the work with a written offer, valid for at 307 | least three years, to give the same user the materials 308 | specified in Subsection 6a, above, for a charge no more 309 | than the cost of performing this distribution. 310 | 311 | d) If distribution of the work is made by offering access to copy 312 | from a designated place, offer equivalent access to copy the above 313 | specified materials from the same place. 314 | 315 | e) Verify that the user has already received a copy of these 316 | materials or that you have already sent this user a copy. 317 | 318 | For an executable, the required form of the "work that uses the 319 | Library" must include any data and utility programs needed for 320 | reproducing the executable from it. However, as a special exception, 321 | the materials to be distributed need not include anything that is 322 | normally distributed (in either source or binary form) with the major 323 | components (compiler, kernel, and so on) of the operating system on 324 | which the executable runs, unless that component itself accompanies 325 | the executable. 326 | 327 | It may happen that this requirement contradicts the license 328 | restrictions of other proprietary libraries that do not normally 329 | accompany the operating system. Such a contradiction means you cannot 330 | use both them and the Library together in an executable that you 331 | distribute. 332 | 333 | 7. You may place library facilities that are a work based on the 334 | Library side-by-side in a single library together with other library 335 | facilities not covered by this License, and distribute such a combined 336 | library, provided that the separate distribution of the work based on 337 | the Library and of the other library facilities is otherwise 338 | permitted, and provided that you do these two things: 339 | 340 | a) Accompany the combined library with a copy of the same work 341 | based on the Library, uncombined with any other library 342 | facilities. This must be distributed under the terms of the 343 | Sections above. 344 | 345 | b) Give prominent notice with the combined library of the fact 346 | that part of it is a work based on the Library, and explaining 347 | where to find the accompanying uncombined form of the same work. 348 | 349 | 8. You may not copy, modify, sublicense, link with, or distribute 350 | the Library except as expressly provided under this License. Any 351 | attempt otherwise to copy, modify, sublicense, link with, or 352 | distribute the Library is void, and will automatically terminate your 353 | rights under this License. However, parties who have received copies, 354 | or rights, from you under this License will not have their licenses 355 | terminated so long as such parties remain in full compliance. 356 | 357 | 9. You are not required to accept this License, since you have not 358 | signed it. However, nothing else grants you permission to modify or 359 | distribute the Library or its derivative works. These actions are 360 | prohibited by law if you do not accept this License. Therefore, by 361 | modifying or distributing the Library (or any work based on the 362 | Library), you indicate your acceptance of this License to do so, and 363 | all its terms and conditions for copying, distributing or modifying 364 | the Library or works based on it. 365 | 366 | 10. Each time you redistribute the Library (or any work based on the 367 | Library), the recipient automatically receives a license from the 368 | original licensor to copy, distribute, link with or modify the Library 369 | subject to these terms and conditions. You may not impose any further 370 | restrictions on the recipients' exercise of the rights granted herein. 371 | You are not responsible for enforcing compliance by third parties with 372 | this License. 373 | 374 | 11. If, as a consequence of a court judgment or allegation of patent 375 | infringement or for any other reason (not limited to patent issues), 376 | conditions are imposed on you (whether by court order, agreement or 377 | otherwise) that contradict the conditions of this License, they do not 378 | excuse you from the conditions of this License. If you cannot 379 | distribute so as to satisfy simultaneously your obligations under this 380 | License and any other pertinent obligations, then as a consequence you 381 | may not distribute the Library at all. For example, if a patent 382 | license would not permit royalty-free redistribution of the Library by 383 | all those who receive copies directly or indirectly through you, then 384 | the only way you could satisfy both it and this License would be to 385 | refrain entirely from distribution of the Library. 386 | 387 | If any portion of this section is held invalid or unenforceable under any 388 | particular circumstance, the balance of the section is intended to apply, 389 | and the section as a whole is intended to apply in other circumstances. 390 | 391 | It is not the purpose of this section to induce you to infringe any 392 | patents or other property right claims or to contest validity of any 393 | such claims; this section has the sole purpose of protecting the 394 | integrity of the free software distribution system which is 395 | implemented by public license practices. Many people have made 396 | generous contributions to the wide range of software distributed 397 | through that system in reliance on consistent application of that 398 | system; it is up to the author/donor to decide if he or she is willing 399 | to distribute software through any other system and a licensee cannot 400 | impose that choice. 401 | 402 | This section is intended to make thoroughly clear what is believed to 403 | be a consequence of the rest of this License. 404 | 405 | 12. If the distribution and/or use of the Library is restricted in 406 | certain countries either by patents or by copyrighted interfaces, the 407 | original copyright holder who places the Library under this License may add 408 | an explicit geographical distribution limitation excluding those countries, 409 | so that distribution is permitted only in or among countries not thus 410 | excluded. In such case, this License incorporates the limitation as if 411 | written in the body of this License. 412 | 413 | 13. The Free Software Foundation may publish revised and/or new 414 | versions of the Lesser General Public License from time to time. 415 | Such new versions will be similar in spirit to the present version, 416 | but may differ in detail to address new problems or concerns. 417 | 418 | Each version is given a distinguishing version number. If the Library 419 | specifies a version number of this License which applies to it and 420 | "any later version", you have the option of following the terms and 421 | conditions either of that version or of any later version published by 422 | the Free Software Foundation. If the Library does not specify a 423 | license version number, you may choose any version ever published by 424 | the Free Software Foundation. 425 | 426 | 14. If you wish to incorporate parts of the Library into other free 427 | programs whose distribution conditions are incompatible with these, 428 | write to the author to ask for permission. For software which is 429 | copyrighted by the Free Software Foundation, write to the Free 430 | Software Foundation; we sometimes make exceptions for this. Our 431 | decision will be guided by the two goals of preserving the free status 432 | of all derivatives of our free software and of promoting the sharing 433 | and reuse of software generally. 434 | 435 | NO WARRANTY 436 | 437 | 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO 438 | WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. 439 | EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR 440 | OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY 441 | KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE 442 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 443 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE 444 | LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME 445 | THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 446 | 447 | 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN 448 | WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY 449 | AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU 450 | FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR 451 | CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE 452 | LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING 453 | RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A 454 | FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF 455 | SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 456 | DAMAGES. 457 | 458 | END OF TERMS AND CONDITIONS 459 | 460 | How to Apply These Terms to Your New Libraries 461 | 462 | If you develop a new library, and you want it to be of the greatest 463 | possible use to the public, we recommend making it free software that 464 | everyone can redistribute and change. You can do so by permitting 465 | redistribution under these terms (or, alternatively, under the terms of the 466 | ordinary General Public License). 467 | 468 | To apply these terms, attach the following notices to the library. It is 469 | safest to attach them to the start of each source file to most effectively 470 | convey the exclusion of warranty; and each file should have at least the 471 | "copyright" line and a pointer to where the full notice is found. 472 | 473 | 474 | Copyright (C) 475 | 476 | This library is free software; you can redistribute it and/or 477 | modify it under the terms of the GNU Lesser General Public 478 | License as published by the Free Software Foundation; either 479 | version 2.1 of the License, or (at your option) any later version. 480 | 481 | This library is distributed in the hope that it will be useful, 482 | but WITHOUT ANY WARRANTY; without even the implied warranty of 483 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 484 | Lesser General Public License for more details. 485 | 486 | You should have received a copy of the GNU Lesser General Public 487 | License along with this library; if not, write to the Free Software 488 | Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 489 | USA 490 | 491 | Also add information on how to contact you by electronic and paper mail. 492 | 493 | You should also get your employer (if you work as a programmer) or your 494 | school, if any, to sign a "copyright disclaimer" for the library, if 495 | necessary. Here is a sample; alter the names: 496 | 497 | Yoyodyne, Inc., hereby disclaims all copyright interest in the 498 | library `Frob' (a library for tweaking knobs) written by James Random 499 | Hacker. 500 | 501 | , 1 April 1990 502 | Ty Coon, President of Vice 503 | 504 | That's all there is to it! 505 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # factorio-rcon-py 2 | 3 | A simple Factorio RCON client 4 | 5 | ## Install 6 | 7 | Without async support 8 | `pip install factorio-rcon-py` 9 | 10 | With async support 11 | `pip install factorio-rcon-py[async]` 12 | 13 | Async support is available as soon as the required dependency (anyio) is installed, so `pip install factorio-rcon-py anyio` is mostly equivalent, but not recommended due to dependency versioning. 14 | 15 | Python 3.8+ is required. 16 | 17 | ## Usage 18 | 19 | Example: 20 | ```python 21 | import factorio_rcon 22 | 23 | client = factorio_rcon.RCONClient("127.0.0.1", 12345, "mypassword") 24 | response = client.send_command("/help") 25 | ``` 26 | 27 | All documentation is in the docstrings of each class/method. 28 | 29 | Asynchronous usage of this module is possible thanks to [anyio](https://github.com/agronholm/anyio). This means that you can use the async client with asyncio and trio. Use the AsyncRCONClient class. More details are in its docstring. 30 | 31 | Available methods in both classes are (see docstrings for more info): 32 | * connect - Connects to the RCON server. 33 | * close - Closes the connection to the RCON server. 34 | * send_packet - Sends a packet to the RCON server. 35 | * receive_packet - Receives a packet from the RCON server. 36 | * send_command - Sends a single command to the RCON server. 37 | * send_commands - Sends multiple commands to the RCON server. 38 | 39 | Note that both the sync/async clients can be used as sync/async context managers respectively. 40 | 41 | The methods for sending/receiving packets are available in case you want to 42 | write your own packet handlers, but in most cases you will never need to touch 43 | these and can use send_command(s). 44 | 45 | ## Mentions 46 | 47 | Thanks to: 48 | - [Truman Kilen](https://github.com/trumank) for the initial code / idea. 49 | - [De Sa Léo](https://github.com/desaleo) for contributing context manager support and typing improvements. 50 | 51 | ## License 52 | 53 | LGPLv2.1 54 | -------------------------------------------------------------------------------- /factorio_rcon/__init__.py: -------------------------------------------------------------------------------- 1 | from ._impl import ( 2 | AsyncRCONClient as AsyncRCONClient, 3 | InvalidPassword as InvalidPassword, 4 | InvalidResponse as InvalidResponse, 5 | PacketType as PacketType, 6 | RCONBaseError as RCONBaseError, 7 | RCONClient as RCONClient, 8 | RCONClosed as RCONClosed, 9 | RCONConnectError as RCONConnectError, 10 | RCONMessage as RCONMessage, 11 | RCONNetworkError as RCONNetworkError, 12 | RCONNotConnected as RCONNotConnected, 13 | RCONReceiveError as RCONReceiveError, 14 | RCONSendError as RCONSendError, 15 | RCONSharedBase as RCONSharedBase, 16 | ) 17 | 18 | # update the module paths to avoid factorio_rcon._impl.obj names 19 | for value in locals().copy().values(): 20 | if getattr(value, "__module__", "").startswith("factorio_rcon."): 21 | value.__module__ = __name__ 22 | # make sure value doesn't hang around as a module attribute 23 | del value # pylint: disable=undefined-loop-variable 24 | -------------------------------------------------------------------------------- /factorio_rcon/_impl.py: -------------------------------------------------------------------------------- 1 | """RCON client for Factorio servers""" 2 | 3 | import enum 4 | import functools 5 | import socket 6 | import struct 7 | from types import TracebackType 8 | from typing import Any, Callable, Dict, NamedTuple, Optional, Type, TypeVar, cast 9 | 10 | try: 11 | import anyio 12 | except ImportError: 13 | ASYNC_AVAILABLE = False 14 | else: 15 | ASYNC_AVAILABLE = True 16 | 17 | RECV_SIZE = 4096 18 | T = TypeVar("T") 19 | F = TypeVar("F", bound=Callable[..., Any]) 20 | 21 | 22 | class PacketType(enum.IntEnum): 23 | """RCON packet types""" 24 | 25 | RESPONSE_VALUE = 0 26 | EXECCOMMAND = 2 27 | AUTH_RESPONSE = 2 28 | AUTH = 3 29 | 30 | 31 | class RCONMessage(NamedTuple): 32 | """RCON message 33 | 34 | Attrs: 35 | id: int; message id. 36 | type: PacketType; message type. 37 | body: Optional[str]; message body. 38 | """ 39 | 40 | id: int 41 | type: PacketType 42 | body: Optional[str] 43 | 44 | 45 | class RCONBaseError(Exception): 46 | """Exception base for all exceptions in this library""" 47 | 48 | 49 | class InvalidPassword(RCONBaseError): 50 | """RCON password is incorrect""" 51 | 52 | 53 | class InvalidResponse(RCONBaseError): 54 | """RCON server returned an unparsable response or one with an unknown ID""" 55 | 56 | 57 | class RCONNetworkError(RCONBaseError): 58 | """Base for all network related exceptions""" 59 | 60 | 61 | class RCONNotConnected(RCONNetworkError): 62 | """Client is not connected to the RCON server""" 63 | 64 | 65 | class RCONClosed(RCONNetworkError): 66 | """RCON server closed the connection""" 67 | 68 | 69 | class RCONConnectError(RCONNetworkError): 70 | """Error connecting to the RCON server""" 71 | 72 | 73 | class RCONSendError(RCONNetworkError): 74 | """Error sending data to the RCON server""" 75 | 76 | 77 | class RCONReceiveError(RCONNetworkError): 78 | """Error receiving data from the RCON server""" 79 | 80 | 81 | class RCONSharedBase: 82 | """Methods and data shared between both client classes""" 83 | 84 | rcon_socket: Any 85 | message_format = " None: 89 | self.id_seq = 0 90 | self.rcon_socket = None 91 | self.rcon_failure = False 92 | 93 | def get_id(self) -> int: 94 | """Gets an id for a command to be sent""" 95 | if self.id_seq == 2**31 - 1: # signed int32 max 96 | self.id_seq = 0 97 | else: 98 | self.id_seq += 1 99 | return self.id_seq 100 | 101 | @classmethod 102 | def build_message(cls, message: RCONMessage) -> bytes: 103 | """Build a message into bytes""" 104 | if message.body is not None: 105 | encoded_body = message.body.encode("utf-8") 106 | else: 107 | encoded_body = b"" 108 | return struct.pack( 109 | cls.message_format.format(len(encoded_body)), 110 | cls.fixed_length + len(encoded_body), 111 | message.id, 112 | message.type, 113 | encoded_body, 114 | 0, 115 | ) 116 | 117 | @classmethod 118 | def parse_message(cls, message: bytes, length: int) -> RCONMessage: 119 | """Parse a message into an RCONMessage tuple""" 120 | try: 121 | data = struct.unpack( 122 | cls.message_format.format(length - cls.fixed_length), message 123 | ) 124 | return RCONMessage( 125 | data[1], data[2], data[3].decode("utf-8") if data[3] else None 126 | ) 127 | except (struct.error, UnicodeError) as exc: 128 | raise InvalidResponse(PARSE_FAILED) from exc 129 | 130 | 131 | def handle_socket_errors(alive_socket_required: bool = True) -> Callable[[F], F]: 132 | """Socket error checking decorator""" 133 | 134 | def real_decorator(function: F) -> F: 135 | @functools.wraps(function) 136 | # paramspec can be used to type here, but 3.10+ only 137 | def wrapper(self, *args, **kwargs): 138 | if alive_socket_required: 139 | if self.rcon_socket is None: 140 | raise RCONNotConnected(NOT_CONNECTED) 141 | if self.rcon_failure: 142 | raise RCONNotConnected(RCON_FAILED) 143 | try: 144 | return function(self, *args, **kwargs) 145 | except BaseException: 146 | self.rcon_failure = True 147 | self.close() 148 | raise 149 | 150 | return cast(F, wrapper) 151 | 152 | return real_decorator 153 | 154 | 155 | def async_handle_socket_errors(alive_socket_required: bool = True) -> Callable[[F], F]: 156 | """Socket error checking decorator (async)""" 157 | 158 | def real_decorator(function: F) -> F: 159 | @functools.wraps(function) 160 | async def wrapper(self, *args, **kwargs): 161 | if alive_socket_required: 162 | if self.rcon_socket is None: 163 | raise RCONNotConnected(NOT_CONNECTED) 164 | if self.rcon_failure: 165 | raise RCONNotConnected(RCON_FAILED) 166 | try: 167 | return await function(self, *args, **kwargs) 168 | except BaseException: 169 | self.rcon_failure = True 170 | await self.close() 171 | raise 172 | 173 | return cast(F, wrapper) 174 | 175 | return real_decorator 176 | 177 | 178 | class RCONClient(RCONSharedBase): 179 | """RCON client for Factorio servers 180 | 181 | Params: 182 | ip_address: str; IP address to connect to. 183 | port: int; port to connect to. 184 | password: str; password to use to authenticate. 185 | timeout (default None): Optional[float]; timeout for socket operations. 186 | connect_on_init (default True): bool; connect to the server when initialised. 187 | Raises: 188 | If connect_on_init is set, see RCONClient.connect(). 189 | Else, no specific exceptions. 190 | Extra information: 191 | **All methods are not thread safe** 192 | Use AsyncRCONClient for coroutine based concurrency. 193 | This is usable as a context manager. 194 | If any exception is raised (all inherit from RCONBaseError) during operation, 195 | it is required that you reconnect to the RCON server (with .connect()). 196 | The server will not respond to any RCON requests if it is saving, so you should 197 | set a socket timeout if you are not prepared to wait a few seconds if the map is 198 | large or the server slow. 199 | A specified timeout of zero will disable any timeout rather than set non-blocking mode. 200 | """ 201 | 202 | rcon_socket: Optional[socket.socket] 203 | 204 | def __init__( 205 | self, 206 | ip_address: str, 207 | port: int, 208 | password: str, 209 | timeout: Optional[float] = None, 210 | connect_on_init: bool = True, 211 | ) -> None: 212 | super().__init__() 213 | self.timeout = timeout 214 | if timeout == 0: 215 | self.timeout = None 216 | self.ip_address = ip_address 217 | self.port = port 218 | self.password = password 219 | if connect_on_init: 220 | self.connect() 221 | 222 | @handle_socket_errors(alive_socket_required=False) 223 | def connect(self) -> None: 224 | """Connects to the RCON server 225 | 226 | Params: 227 | No params. 228 | Raises: 229 | RCONConnectError: if there is an error connecting to the server. 230 | InvalidPassword: if the password is incorrect. 231 | InvalidResponse: if the server returns an invalid response. 232 | Returns: 233 | Nothing returned. 234 | Extra information: 235 | Use this function to reconnect to the RCON server after an error. 236 | """ 237 | self.close() 238 | self.rcon_failure = False 239 | self.rcon_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) 240 | self.rcon_socket.settimeout(self.timeout) 241 | try: 242 | self.rcon_socket.connect((self.ip_address, self.port)) 243 | except Exception as exc: 244 | raise RCONConnectError(CONNECT_SOCKET_ERROR) from exc 245 | self.id_seq = 0 246 | try: 247 | self.send_packet(self.id_seq, PacketType.AUTH, self.password) 248 | response = self.receive_packet() 249 | except RCONBaseError as exc: 250 | raise RCONConnectError(CONNECT_COMMUNICATION_ERROR) from exc 251 | if response.type != PacketType.AUTH_RESPONSE: 252 | raise InvalidResponse(INVALID_TYPE) 253 | if response.id == -1: 254 | raise InvalidPassword(INVALID_PASS) 255 | if response.id != self.id_seq: 256 | raise InvalidResponse(INVALID_ID) 257 | 258 | def close(self) -> None: 259 | """Closes the connection to the RCON server 260 | 261 | Params: 262 | No params. 263 | Raises: 264 | No specific exceptions. 265 | Returns: 266 | Nothing returned. 267 | Extra information: 268 | Guaranteed to succeed, even if the client is not currently connected. 269 | After closing, the client can still be reconnected using .connect(). 270 | """ 271 | if self.rcon_socket is not None: 272 | self.rcon_socket.close() 273 | self.rcon_socket = None 274 | 275 | def send_packet( 276 | self, packet_id: int, packet_type: PacketType, packet_body: str 277 | ) -> None: 278 | """Sends a packet to the RCON server 279 | 280 | Params: 281 | packet_id: int; id of packet being sent. 282 | packet_type: PacketType; type of packet being sent. 283 | packet_body: str; payload for the packet (usually a command). 284 | Raises: 285 | RCONNotConnected: if the client is not connected to the RCON server. 286 | RCONSendError: if any error occurs while sending the data (including a timeout). 287 | Returns: 288 | Nothing returned. 289 | Extra information: 290 | See RCON protocol specification for what the id and type represent. 291 | """ 292 | if self.rcon_socket is None: 293 | raise RCONNotConnected(NOT_CONNECTED) 294 | packet = self.build_message( 295 | RCONMessage(id=packet_id, type=packet_type, body=packet_body) 296 | ) 297 | try: 298 | self.rcon_socket.sendall(packet) 299 | except (socket.timeout, TimeoutError) as exc: 300 | raise RCONSendError(CONN_TIMEOUT) from exc 301 | except Exception as exc: 302 | raise RCONSendError(SEND_ERROR) from exc 303 | 304 | @staticmethod 305 | def receive_exactly(rcon_socket: socket.socket, size: int) -> bytes: 306 | """Receive exactly size bytes 307 | 308 | On socket closure: returns empty bytes 309 | """ 310 | buffer = bytearray() 311 | while len(buffer) < size: 312 | read_data = rcon_socket.recv(min(size - len(buffer), RECV_SIZE)) 313 | if not read_data: 314 | return b"" 315 | buffer.extend(read_data) 316 | return buffer 317 | 318 | def receive_packet(self) -> RCONMessage: 319 | """Receives a packet from the RCON server 320 | 321 | Params: 322 | No params. 323 | Raises: 324 | RCONNotConnected: if the client is not connected to the RCON server. 325 | InvalidResponse: if the received data could not be parsed into a response. 326 | RCONClosed: if the server closes the connection. 327 | RCONReceiveError: if any other error occurs while receiving data (including a timeout). 328 | Returns: 329 | RCONMessage of the response. 330 | Extra information: 331 | See the docstring for RCONMessage for available attributes. 332 | """ 333 | if self.rcon_socket is None: 334 | raise RCONNotConnected(NOT_CONNECTED) 335 | try: 336 | data = bytearray() 337 | data.extend(self.receive_exactly(self.rcon_socket, 4)) 338 | if not data: 339 | raise RCONClosed(CONN_CLOSED) 340 | length = int.from_bytes(data, "little") 341 | read_data = self.receive_exactly(self.rcon_socket, length) 342 | if not read_data: 343 | raise RCONClosed(CONN_CLOSED) 344 | data.extend(read_data) 345 | return self.parse_message(data, length) 346 | except (RCONClosed, InvalidResponse): 347 | raise 348 | except (socket.timeout, TimeoutError) as exc: 349 | raise RCONReceiveError(CONN_TIMEOUT) from exc 350 | except Exception as exc: 351 | raise RCONReceiveError(RECEIVE_ERROR) from exc 352 | 353 | def send_command(self, command: str) -> Optional[str]: 354 | """Sends a single command to the RCON server 355 | 356 | Params: 357 | command: str; the command to be executed. 358 | Raises: 359 | RCONNotConnected: if the client is not connected to the RCON server. 360 | InvalidResponse: if the server returns an invalid response. 361 | RCONClosed: if the server closes the connection. 362 | RCONSendError: if any other error occurs while sending the request (including a timeout). 363 | RCONReceiveError: if any other error occurs while receiving the response (including a timeout). 364 | Returns: 365 | str if data is returned. 366 | None if no data is returned. 367 | Extra information: 368 | **This method is NOT thread safe** 369 | Use send_commands if multiple commands are being executed, 370 | it will be much faster as all of the requests can be sent simultaneously. 371 | """ 372 | return self.send_commands({"command": command})["command"] 373 | 374 | @handle_socket_errors() 375 | def send_commands(self, commands: Dict[T, str]) -> Dict[T, Optional[str]]: 376 | """Sends multiple commands to the RCON server 377 | 378 | Params: 379 | commands: Dict[T, str]; commands to be executed. 380 | Raises: 381 | RCONNotConnected: if the client is not connected to the RCON server. 382 | InvalidResponse: if the server returns an invalid response. 383 | RCONClosed: if the server closes the connection. 384 | RCONSendError: if any other error occurs while sending the request (including a timeout). 385 | RCONReceiveError: if any other error occurs while receiving the response (including a timeout). 386 | Returns: 387 | dict of format key: response. 388 | Extra information: 389 | **This method is NOT thread safe** 390 | Structure of the commands dictionary: 391 | key: an identifier for each command in the response. 392 | value: command to be executed. 393 | """ 394 | id_map = {} 395 | results: Dict[T, Optional[str]] = {} 396 | for key, value in commands.items(): 397 | packet_id = self.get_id() 398 | self.send_packet(packet_id, PacketType.EXECCOMMAND, value) 399 | id_map[packet_id] = key 400 | responses = [self.receive_packet() for _ in commands] 401 | for response in responses: 402 | if response.id not in id_map: 403 | raise InvalidResponse(INVALID_ID) 404 | if response.type != PacketType.RESPONSE_VALUE: 405 | raise InvalidResponse(INVALID_TYPE) 406 | if response.body is None: 407 | results[id_map[response.id]] = None 408 | else: 409 | results[id_map[response.id]] = response.body.rstrip() 410 | return results 411 | 412 | @handle_socket_errors(alive_socket_required=False) 413 | def __enter__(self) -> "RCONClient": 414 | if self.rcon_socket is None or self.rcon_failure: 415 | self.connect() 416 | return self 417 | 418 | def __exit__( 419 | self, 420 | exc_type: Optional[Type[BaseException]], 421 | exc_value: Optional[BaseException], 422 | traceback: Optional[TracebackType], 423 | ) -> None: 424 | self.close() 425 | 426 | 427 | class AsyncRCONClient(RCONSharedBase): 428 | """Asynchronous RCON client for Factorio servers 429 | 430 | Params: 431 | ip_address: str; IP address to connect to. 432 | port: int; port to connect to. 433 | password: str; password to use to authenticate. 434 | **connect_on_init is not supported** 435 | Raises: 436 | ImportError: if anyio is not installed. 437 | Extra information: 438 | **Async involving this module is performed using anyio** 439 | 440 | anyio allows you to use either asyncio or trio. 441 | All functions in this class are async. 442 | This is usable as an async context manager. 443 | If you want to set timeouts, use the cancellation system your existing framework 444 | provides or use anyio.move_on_after/fail_after. 445 | See https://anyio.readthedocs.io/en/latest/cancellation.html#timeouts. 446 | 447 | If any exception is raised (all inherit from RCONBaseError) during operation, 448 | it is required that you reconnect to the RCON server (with .connect()). 449 | The server will not respond to any RCON requests if it is saving, so you should 450 | use a timeout if you are not prepared to wait a few seconds if the map is 451 | large or the server slow. 452 | """ 453 | 454 | rcon_socket: Optional["anyio.abc.SocketStream"] 455 | 456 | def __init__(self, ip_address: str, port: int, password: str) -> None: 457 | if not ASYNC_AVAILABLE: 458 | raise ImportError( 459 | "anyio must be installed to use the async client", name="anyio" 460 | ) 461 | super().__init__() 462 | self.ip_address = ip_address 463 | self.port = port 464 | self.password = password 465 | 466 | @async_handle_socket_errors(alive_socket_required=False) 467 | async def connect(self) -> None: 468 | """Connects to the RCON server asynchronously 469 | 470 | Params: 471 | No params. 472 | Raises: 473 | RCONConnectError: if there is an error connecting to the server. 474 | InvalidPassword: if the password is incorrect. 475 | InvalidResponse: if the server returns an invalid response. 476 | Returns: 477 | Nothing returned. 478 | Extra information: 479 | Use this function to reconnect to the RCON server after an error. 480 | """ 481 | await self.close() 482 | self.rcon_failure = False 483 | try: 484 | self.rcon_socket = await anyio.connect_tcp(self.ip_address, self.port) 485 | except Exception as exc: 486 | raise RCONConnectError(CONNECT_SOCKET_ERROR) from exc 487 | self.id_seq = 0 488 | try: 489 | await self.send_packet(self.id_seq, PacketType.AUTH, self.password) 490 | response = await self.receive_packet() 491 | except RCONBaseError as exc: 492 | raise RCONConnectError(CONNECT_COMMUNICATION_ERROR) from exc 493 | if response.type != PacketType.AUTH_RESPONSE: 494 | raise InvalidResponse(INVALID_TYPE) 495 | if response.id == -1: 496 | raise InvalidPassword(INVALID_PASS) 497 | if response.id != self.id_seq: 498 | raise InvalidResponse(INVALID_ID) 499 | 500 | async def close(self) -> None: 501 | """Closes the connection to the RCON server asynchronously 502 | 503 | Params: 504 | No params. 505 | Raises: 506 | No specific exceptions. 507 | Returns: 508 | Nothing returned. 509 | Extra information: 510 | Guaranteed to succeed, even if the client is not currently connected. 511 | After closing, the client can still be reconnected using .connect(). 512 | """ 513 | if self.rcon_socket is not None: 514 | await self.rcon_socket.aclose() 515 | self.rcon_socket = None 516 | 517 | async def send_packet( 518 | self, packet_id: int, packet_type: PacketType, packet_body: str 519 | ) -> None: 520 | """Sends a packet to the RCON server asynchronously 521 | 522 | Params: 523 | packet_id: int; id of packet being sent. 524 | packet_type: PacketType; type of packet being sent. 525 | packet_body: str; payload for the packet (usually a command). 526 | Raises: 527 | RCONNotConnected: if the client is not connected to the RCON server. 528 | RCONSendError: if any error occurs while sending the data. 529 | Returns: 530 | Nothing returned. 531 | Extra information: 532 | See RCON protocol specification for what the id and type represent. 533 | """ 534 | if self.rcon_socket is None: 535 | raise RCONNotConnected(NOT_CONNECTED) 536 | packet = self.build_message( 537 | RCONMessage(id=packet_id, type=packet_type, body=packet_body) 538 | ) 539 | try: 540 | await self.rcon_socket.send(packet) 541 | except Exception as exc: 542 | raise RCONSendError(SEND_ERROR) from exc 543 | 544 | @staticmethod 545 | async def receive_exactly( 546 | rcon_socket: "anyio.abc.SocketStream", size: int 547 | ) -> bytes: 548 | """Receive exactly size bytes 549 | 550 | On socket closure: raises anyio.EndOfStream 551 | """ 552 | buffer = bytearray() 553 | while len(buffer) < size: 554 | buffer.extend(await rcon_socket.receive(min(size - len(buffer), RECV_SIZE))) 555 | return buffer 556 | 557 | async def receive_packet(self) -> RCONMessage: 558 | """Receives a packet from the RCON server asynchronously 559 | 560 | Params: 561 | No params. 562 | Raises: 563 | RCONNotConnected: if the client is not connected to the RCON server. 564 | InvalidResponse: if the received data could not be parsed into responses. 565 | RCONClosed: if the server closes the connection. 566 | RCONReceiveError: if any other error occurs while receiving data. 567 | Returns: 568 | RCONMessage of the response. 569 | Extra information: 570 | See the docstring for RCONMessage for available attributes. 571 | """ 572 | if self.rcon_socket is None: 573 | raise RCONNotConnected(NOT_CONNECTED) 574 | try: 575 | data = bytearray() 576 | data.extend(await self.receive_exactly(self.rcon_socket, 4)) 577 | length = int.from_bytes(data, "little") 578 | data.extend(await self.receive_exactly(self.rcon_socket, length)) 579 | return self.parse_message(data, length) 580 | except InvalidResponse: 581 | raise 582 | except anyio.EndOfStream as exc: 583 | raise RCONClosed(CONN_CLOSED) from exc 584 | except Exception as exc: 585 | raise RCONReceiveError(RECEIVE_ERROR) from exc 586 | 587 | async def send_command(self, command: str) -> Optional[str]: 588 | """Sends a command to the RCON server asynchronously 589 | 590 | Params: 591 | command: str; the command to be executed. 592 | Raises: 593 | RCONNotConnected: if the client is not connected to the RCON server. 594 | InvalidResponse: if the server returns an invalid response. 595 | RCONClosed: if the server closes the connection. 596 | RCONSendError: if any other error occurs while sending the request. 597 | RCONReceiveError: if any other error occurs while receiving the response. 598 | Returns: 599 | str if data is returned. 600 | None if no data is returned. 601 | Extra information: 602 | Use send_commands if multiple commands are being executed, 603 | it will be much faster as all of the requests can be sent simultaneously. 604 | """ 605 | return (await self.send_commands({"command": command}))["command"] 606 | 607 | @async_handle_socket_errors() 608 | async def send_commands(self, commands: Dict[T, str]) -> Dict[T, Optional[str]]: 609 | """Sends multiple commands to the RCON server asynchronously 610 | 611 | Params: 612 | commands: dict; commands to be executed. 613 | Raises: 614 | RCONNotConnected: if the client is not connected to the RCON server. 615 | InvalidResponse: if the server returns an invalid response. 616 | RCONClosed: if the server closes the connection. 617 | RCONSendError: if any other error occurs while sending the request. 618 | RCONReceiveError: if any other error occurs while receiving the response. 619 | Returns: 620 | dict of format key: response. 621 | Extra information: 622 | Structure of the commands dictionary: 623 | key: an identifier for each command in the response. 624 | value: command to be executed 625 | """ 626 | id_map = {} 627 | results: Dict[T, Optional[str]] = {} 628 | for key, value in commands.items(): 629 | packet_id = self.get_id() 630 | await self.send_packet(packet_id, PacketType.EXECCOMMAND, value) 631 | id_map[packet_id] = key 632 | responses = [await self.receive_packet() for _ in commands] 633 | for response in responses: 634 | if response.id not in id_map: 635 | raise InvalidResponse(INVALID_ID) 636 | if response.type != PacketType.RESPONSE_VALUE: 637 | raise InvalidResponse(INVALID_TYPE) 638 | if response.body is None: 639 | results[id_map[response.id]] = None 640 | else: 641 | results[id_map[response.id]] = response.body.rstrip() 642 | return results 643 | 644 | @async_handle_socket_errors(alive_socket_required=False) 645 | async def __aenter__(self) -> "AsyncRCONClient": 646 | if self.rcon_socket is None or self.rcon_failure: 647 | await self.connect() 648 | return self 649 | 650 | async def __aexit__( 651 | self, 652 | exc_type: Optional[Type[BaseException]], 653 | exc_value: Optional[BaseException], 654 | traceback: Optional[TracebackType], 655 | ) -> None: 656 | await self.close() 657 | 658 | 659 | INVALID_PASS = "The RCON password is incorrect" 660 | INVALID_ID = ( 661 | "The RCON server returned a response with an unknown sequence ID. This means that " 662 | "a response was received for a command that was not sent. This situation implies " 663 | "a bug in this RCON library or the RCON server behaving incorrectly. " 664 | "If this behaviour is intentional, you can use receive_packet()." 665 | ) 666 | INVALID_TYPE = ( 667 | "The RCON server returned a response of unexpected or unknown type. This situation implies " 668 | "a bug in this RCON library or the RCON server behaving incorrectly. " 669 | "If this behaviour is intentional, you can use receive_packet()." 670 | ) 671 | PARSE_FAILED = ( 672 | "The RCON server returned data that could not be parsed into response messages" 673 | ) 674 | NOT_CONNECTED = "The RCON client is currently not connected to the server" 675 | RCON_FAILED = ( 676 | "An error has occurred and the client is no longer connected to the RCON server " 677 | "(reconnect with connect())" 678 | ) 679 | CONN_CLOSED = "The RCON server closed the connection" 680 | CONN_TIMEOUT = "The connection timed out while communicating with the server" 681 | CONNECT_SOCKET_ERROR = "Failed to establish a connection to the server" 682 | CONNECT_COMMUNICATION_ERROR = "Failed to communicate authentication setup to the server" 683 | SEND_ERROR = "Failed to send data to the RCON server" 684 | RECEIVE_ERROR = "Failed to receive data from the RCON server" 685 | -------------------------------------------------------------------------------- /factorio_rcon/py.typed: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mark9064/factorio-rcon-py/f845dbd5120d4b07ad123d0c30642d784fee7a33/factorio_rcon/py.typed -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools>=62.0"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | name = "factorio-rcon-py" 7 | version = "2.1.3" 8 | description = "A simple Factorio RCON client" 9 | dependencies = [] 10 | readme = "README.md" 11 | requires-python = ">=3.8" 12 | authors = [ 13 | {name = "mark9064"} 14 | ] 15 | classifiers = [ 16 | "Programming Language :: Python :: 3", 17 | "License :: OSI Approved :: GNU Lesser General Public License v2 (LGPLv2)", 18 | "Operating System :: OS Independent", 19 | "Development Status :: 5 - Production/Stable", 20 | "Natural Language :: English" 21 | ] 22 | 23 | [project.optional-dependencies] 24 | async = [ 25 | "anyio>=4.0, <5.0" 26 | ] 27 | 28 | [project.urls] 29 | homepage = "https://github.com/mark9064/factorio-rcon-py" 30 | --------------------------------------------------------------------------------