COMPAS 2.1.1__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (468) hide show
  1. compas/__init__.py +274 -0
  2. compas/__main__.py +31 -0
  3. compas/_iotools.py +80 -0
  4. compas/_os.py +746 -0
  5. compas/colors/__init__.py +14 -0
  6. compas/colors/cmcrameri/acton.txt +256 -0
  7. compas/colors/cmcrameri/actonS.txt +100 -0
  8. compas/colors/cmcrameri/bam.txt +256 -0
  9. compas/colors/cmcrameri/bamO.txt +256 -0
  10. compas/colors/cmcrameri/bamako.txt +256 -0
  11. compas/colors/cmcrameri/bamakoS.txt +100 -0
  12. compas/colors/cmcrameri/batlow.txt +256 -0
  13. compas/colors/cmcrameri/batlowK.txt +256 -0
  14. compas/colors/cmcrameri/batlowS.txt +100 -0
  15. compas/colors/cmcrameri/batlowW.txt +256 -0
  16. compas/colors/cmcrameri/berlin.txt +256 -0
  17. compas/colors/cmcrameri/bilbao.txt +256 -0
  18. compas/colors/cmcrameri/bilbaoS.txt +100 -0
  19. compas/colors/cmcrameri/broc.txt +256 -0
  20. compas/colors/cmcrameri/brocO.txt +256 -0
  21. compas/colors/cmcrameri/buda.txt +256 -0
  22. compas/colors/cmcrameri/budaS.txt +100 -0
  23. compas/colors/cmcrameri/bukavu.txt +256 -0
  24. compas/colors/cmcrameri/cork.txt +256 -0
  25. compas/colors/cmcrameri/corkO.txt +256 -0
  26. compas/colors/cmcrameri/davos.txt +256 -0
  27. compas/colors/cmcrameri/davosS.txt +100 -0
  28. compas/colors/cmcrameri/devon.txt +256 -0
  29. compas/colors/cmcrameri/devonS.txt +100 -0
  30. compas/colors/cmcrameri/fes.txt +256 -0
  31. compas/colors/cmcrameri/grayC.txt +256 -0
  32. compas/colors/cmcrameri/grayCS.txt +100 -0
  33. compas/colors/cmcrameri/hawaii.txt +256 -0
  34. compas/colors/cmcrameri/hawaiiS.txt +100 -0
  35. compas/colors/cmcrameri/imola.txt +256 -0
  36. compas/colors/cmcrameri/imolaS.txt +100 -0
  37. compas/colors/cmcrameri/lajolla.txt +256 -0
  38. compas/colors/cmcrameri/lajollaS.txt +100 -0
  39. compas/colors/cmcrameri/lapaz.txt +256 -0
  40. compas/colors/cmcrameri/lapazS.txt +100 -0
  41. compas/colors/cmcrameri/lisbon.txt +256 -0
  42. compas/colors/cmcrameri/nuuk.txt +256 -0
  43. compas/colors/cmcrameri/nuukS.txt +100 -0
  44. compas/colors/cmcrameri/oleron.txt +256 -0
  45. compas/colors/cmcrameri/oslo.txt +256 -0
  46. compas/colors/cmcrameri/osloS.txt +100 -0
  47. compas/colors/cmcrameri/roma.txt +256 -0
  48. compas/colors/cmcrameri/romaO.txt +256 -0
  49. compas/colors/cmcrameri/tofino.txt +256 -0
  50. compas/colors/cmcrameri/tokyo.txt +256 -0
  51. compas/colors/cmcrameri/tokyoS.txt +100 -0
  52. compas/colors/cmcrameri/turku.txt +256 -0
  53. compas/colors/cmcrameri/turkuS.txt +100 -0
  54. compas/colors/cmcrameri/vanimo.txt +256 -0
  55. compas/colors/cmcrameri/vik.txt +256 -0
  56. compas/colors/cmcrameri/vikO.txt +256 -0
  57. compas/colors/color.py +1118 -0
  58. compas/colors/colordict.py +103 -0
  59. compas/colors/colormap.py +306 -0
  60. compas/colors/html_colors.py +149 -0
  61. compas/colors/mpl_colormap.py +1064 -0
  62. compas/data/__init__.py +31 -0
  63. compas/data/coercion.py +71 -0
  64. compas/data/conftest.py +10 -0
  65. compas/data/data.py +342 -0
  66. compas/data/encoders.py +240 -0
  67. compas/data/exceptions.py +2 -0
  68. compas/data/json.py +240 -0
  69. compas/data/samples/boxes.obj +250 -0
  70. compas/data/samples/butt_model.obj +2829 -0
  71. compas/data/samples/cone.stl +0 -0
  72. compas/data/samples/cube.off +16 -0
  73. compas/data/samples/cube_ascii.stl +56114 -0
  74. compas/data/samples/cube_binary.stl +0 -0
  75. compas/data/samples/cube_binary_2.stl +0 -0
  76. compas/data/samples/doosabin.json +1 -0
  77. compas/data/samples/faces.obj +63 -0
  78. compas/data/samples/faces_big.obj +9663 -0
  79. compas/data/samples/faces_reversed.obj +63 -0
  80. compas/data/samples/fink.obj +135 -0
  81. compas/data/samples/grid_irregular.obj +303 -0
  82. compas/data/samples/hypar.obj +148 -0
  83. compas/data/samples/lines.json +1 -0
  84. compas/data/samples/lines.obj +282 -0
  85. compas/data/samples/lines_big.obj +40322 -0
  86. compas/data/samples/lines_bigger.obj +161282 -0
  87. compas/data/samples/lines_noleaves.obj +422 -0
  88. compas/data/samples/mesh.obj +874 -0
  89. compas/data/samples/mesh_100_faces.json +1893 -0
  90. compas/data/samples/mesh_110_faces.json +2081 -0
  91. compas/data/samples/open_edges.obj +424 -0
  92. compas/data/samples/point.json +1 -0
  93. compas/data/samples/quadmesh.obj +183 -0
  94. compas/data/samples/quadmesh_planar.obj +181 -0
  95. compas/data/samples/saddle.obj +314 -0
  96. compas/data/samples/spline.obj +72 -0
  97. compas/data/samples/tubemesh.json +1 -0
  98. compas/data/samples/tubemesh.obj +378 -0
  99. compas/data/samples/tubemesh.off +374 -0
  100. compas/data/samples/tubemesh.ply +551 -0
  101. compas/data/schema.py +137 -0
  102. compas/data/validators.py +243 -0
  103. compas/datastructures/__init__.py +75 -0
  104. compas/datastructures/_mutablemapping.py +148 -0
  105. compas/datastructures/assembly/__init__.py +0 -0
  106. compas/datastructures/assembly/assembly.py +234 -0
  107. compas/datastructures/assembly/exceptions.py +6 -0
  108. compas/datastructures/assembly/part.py +228 -0
  109. compas/datastructures/attributes.py +85 -0
  110. compas/datastructures/cell_network/__init__.py +0 -0
  111. compas/datastructures/cell_network/cell_network.py +4190 -0
  112. compas/datastructures/datastructure.py +309 -0
  113. compas/datastructures/graph/__init__.py +0 -0
  114. compas/datastructures/graph/duality.py +197 -0
  115. compas/datastructures/graph/graph.py +2478 -0
  116. compas/datastructures/graph/operations/__init__.py +0 -0
  117. compas/datastructures/graph/operations/join.py +124 -0
  118. compas/datastructures/graph/operations/split.py +63 -0
  119. compas/datastructures/graph/planarity.py +292 -0
  120. compas/datastructures/graph/smoothing.py +59 -0
  121. compas/datastructures/mesh/__init__.py +0 -0
  122. compas/datastructures/mesh/conway.py +553 -0
  123. compas/datastructures/mesh/duality.py +104 -0
  124. compas/datastructures/mesh/mesh.py +5103 -0
  125. compas/datastructures/mesh/operations/__init__.py +0 -0
  126. compas/datastructures/mesh/operations/collapse.py +350 -0
  127. compas/datastructures/mesh/operations/extrude.py +0 -0
  128. compas/datastructures/mesh/operations/insert.py +120 -0
  129. compas/datastructures/mesh/operations/merge.py +83 -0
  130. compas/datastructures/mesh/operations/split.py +263 -0
  131. compas/datastructures/mesh/operations/substitute.py +37 -0
  132. compas/datastructures/mesh/operations/swap.py +62 -0
  133. compas/datastructures/mesh/operations/weld.py +107 -0
  134. compas/datastructures/mesh/remesh.py +234 -0
  135. compas/datastructures/mesh/slice.py +170 -0
  136. compas/datastructures/mesh/smoothing.py +187 -0
  137. compas/datastructures/mesh/subdivision.py +754 -0
  138. compas/datastructures/tree/__init__.py +0 -0
  139. compas/datastructures/tree/tree.py +504 -0
  140. compas/datastructures/volmesh/__init__.py +0 -0
  141. compas/datastructures/volmesh/volmesh.py +4203 -0
  142. compas/files/__init__.py +27 -0
  143. compas/files/_xml/__init__.py +0 -0
  144. compas/files/_xml/xml_cli.py +213 -0
  145. compas/files/_xml/xml_cpython.py +32 -0
  146. compas/files/_xml/xml_pre_38.py +58 -0
  147. compas/files/_xml/xml_shared.py +40 -0
  148. compas/files/gltf/__init__.py +0 -0
  149. compas/files/gltf/constants.py +59 -0
  150. compas/files/gltf/data_classes.py +657 -0
  151. compas/files/gltf/extensions.py +317 -0
  152. compas/files/gltf/gltf.py +92 -0
  153. compas/files/gltf/gltf_children.py +64 -0
  154. compas/files/gltf/gltf_content.py +615 -0
  155. compas/files/gltf/gltf_exporter.py +465 -0
  156. compas/files/gltf/gltf_mesh.py +273 -0
  157. compas/files/gltf/gltf_node.py +348 -0
  158. compas/files/gltf/gltf_parser.py +115 -0
  159. compas/files/gltf/gltf_reader.py +310 -0
  160. compas/files/gltf/gltf_scene.py +125 -0
  161. compas/files/gltf/helpers.py +59 -0
  162. compas/files/obj.py +680 -0
  163. compas/files/off.py +296 -0
  164. compas/files/ply.py +697 -0
  165. compas/files/stl.py +436 -0
  166. compas/files/xml.py +328 -0
  167. compas/geometry/__init__.py +772 -0
  168. compas/geometry/_core/__init__.py +0 -0
  169. compas/geometry/_core/_algebra.py +2826 -0
  170. compas/geometry/_core/angles.py +408 -0
  171. compas/geometry/_core/centroids.py +573 -0
  172. compas/geometry/_core/distance.py +895 -0
  173. compas/geometry/_core/normals.py +149 -0
  174. compas/geometry/_core/nurbs.py +367 -0
  175. compas/geometry/_core/predicates_2.py +582 -0
  176. compas/geometry/_core/predicates_3.py +1111 -0
  177. compas/geometry/_core/quaternions.py +196 -0
  178. compas/geometry/_core/size.py +204 -0
  179. compas/geometry/_core/tangent.py +56 -0
  180. compas/geometry/_core/transformations.py +1121 -0
  181. compas/geometry/_core/transformations_numpy.py +279 -0
  182. compas/geometry/bbox.py +145 -0
  183. compas/geometry/bbox_numpy.py +306 -0
  184. compas/geometry/bestfit.py +77 -0
  185. compas/geometry/bestfit_numpy.py +259 -0
  186. compas/geometry/booleans.py +297 -0
  187. compas/geometry/booleans_shapely.py +147 -0
  188. compas/geometry/brep/__init__.py +112 -0
  189. compas/geometry/brep/brep.py +1131 -0
  190. compas/geometry/brep/edge.py +302 -0
  191. compas/geometry/brep/errors.py +22 -0
  192. compas/geometry/brep/face.py +329 -0
  193. compas/geometry/brep/loop.py +87 -0
  194. compas/geometry/brep/trim.py +46 -0
  195. compas/geometry/brep/vertex.py +46 -0
  196. compas/geometry/contours.py +32 -0
  197. compas/geometry/curves/__init__.py +0 -0
  198. compas/geometry/curves/arc.py +429 -0
  199. compas/geometry/curves/bezier.py +345 -0
  200. compas/geometry/curves/circle.py +500 -0
  201. compas/geometry/curves/conic.py +16 -0
  202. compas/geometry/curves/curve.py +614 -0
  203. compas/geometry/curves/ellipse.py +408 -0
  204. compas/geometry/curves/hyperbola.py +336 -0
  205. compas/geometry/curves/line.py +431 -0
  206. compas/geometry/curves/nurbs.py +412 -0
  207. compas/geometry/curves/parabola.py +256 -0
  208. compas/geometry/curves/polyline.py +724 -0
  209. compas/geometry/frame.py +769 -0
  210. compas/geometry/geometry.py +296 -0
  211. compas/geometry/hull.py +146 -0
  212. compas/geometry/hull_numpy.py +82 -0
  213. compas/geometry/icp_numpy.py +104 -0
  214. compas/geometry/interpolation_barycentric.py +38 -0
  215. compas/geometry/interpolation_coons.py +102 -0
  216. compas/geometry/interpolation_tweening.py +87 -0
  217. compas/geometry/intersection.py +121 -0
  218. compas/geometry/intersections.py +1105 -0
  219. compas/geometry/kdtree.py +153 -0
  220. compas/geometry/offset.py +208 -0
  221. compas/geometry/pca_numpy.py +87 -0
  222. compas/geometry/plane.py +657 -0
  223. compas/geometry/point.py +664 -0
  224. compas/geometry/pointcloud.py +409 -0
  225. compas/geometry/polygon.py +473 -0
  226. compas/geometry/polyhedron.py +650 -0
  227. compas/geometry/projection.py +155 -0
  228. compas/geometry/quadmesh_planarize.py +30 -0
  229. compas/geometry/quadmesh_planarize_none.py +114 -0
  230. compas/geometry/quaternion.py +544 -0
  231. compas/geometry/reflection.py +102 -0
  232. compas/geometry/rotation.py +354 -0
  233. compas/geometry/scale.py +100 -0
  234. compas/geometry/shapes/__init__.py +0 -0
  235. compas/geometry/shapes/box.py +747 -0
  236. compas/geometry/shapes/capsule.py +472 -0
  237. compas/geometry/shapes/cone.py +309 -0
  238. compas/geometry/shapes/cylinder.py +355 -0
  239. compas/geometry/shapes/shape.py +300 -0
  240. compas/geometry/shapes/sphere.py +362 -0
  241. compas/geometry/shapes/torus.py +294 -0
  242. compas/geometry/shear.py +115 -0
  243. compas/geometry/surfaces/__init__.py +0 -0
  244. compas/geometry/surfaces/conical.py +166 -0
  245. compas/geometry/surfaces/cylindrical.py +251 -0
  246. compas/geometry/surfaces/extrusion.py +0 -0
  247. compas/geometry/surfaces/nurbs.py +380 -0
  248. compas/geometry/surfaces/planar.py +223 -0
  249. compas/geometry/surfaces/revolution.py +0 -0
  250. compas/geometry/surfaces/spherical.py +259 -0
  251. compas/geometry/surfaces/surface.py +689 -0
  252. compas/geometry/surfaces/toroidal.py +198 -0
  253. compas/geometry/transformation.py +554 -0
  254. compas/geometry/translation.py +104 -0
  255. compas/geometry/triangulation_delaunay.py +102 -0
  256. compas/geometry/triangulation_earclip.py +300 -0
  257. compas/geometry/trimesh_curvature.py +113 -0
  258. compas/geometry/trimesh_descent_numpy.py +26 -0
  259. compas/geometry/trimesh_geodistance.py +35 -0
  260. compas/geometry/trimesh_gradient_numpy.py +74 -0
  261. compas/geometry/trimesh_isolines.py +41 -0
  262. compas/geometry/trimesh_matrices.py +31 -0
  263. compas/geometry/trimesh_matrices_numpy.py +191 -0
  264. compas/geometry/trimesh_parametrisation.py +55 -0
  265. compas/geometry/trimesh_pull_points_numpy.py +216 -0
  266. compas/geometry/trimesh_remeshing.py +97 -0
  267. compas/geometry/trimesh_samplepoints_numpy.py +108 -0
  268. compas/geometry/trimesh_slicing.py +28 -0
  269. compas/geometry/trimesh_smoothing_numpy.py +34 -0
  270. compas/geometry/vector.py +889 -0
  271. compas/itertools.py +441 -0
  272. compas/linalg.py +634 -0
  273. compas/matrices.py +314 -0
  274. compas/plugins.py +488 -0
  275. compas/rpc/__init__.py +20 -0
  276. compas/rpc/__main__.py +77 -0
  277. compas/rpc/dispatcher.py +181 -0
  278. compas/rpc/errors.py +11 -0
  279. compas/rpc/proxy.py +437 -0
  280. compas/rpc/server.py +79 -0
  281. compas/rpc/services/__init__.py +0 -0
  282. compas/rpc/services/default.py +87 -0
  283. compas/rpc/services/watcher.py +43 -0
  284. compas/scene/__init__.py +56 -0
  285. compas/scene/assemblyobject.py +3 -0
  286. compas/scene/context.py +154 -0
  287. compas/scene/descriptors/__init__.py +0 -0
  288. compas/scene/descriptors/attribute.py +30 -0
  289. compas/scene/descriptors/color.py +91 -0
  290. compas/scene/descriptors/colordict.py +101 -0
  291. compas/scene/descriptors/protocol.py +12 -0
  292. compas/scene/exceptions.py +7 -0
  293. compas/scene/geometryobject.py +58 -0
  294. compas/scene/graphobject.py +173 -0
  295. compas/scene/meshobject.py +238 -0
  296. compas/scene/scene.py +144 -0
  297. compas/scene/sceneobject.py +253 -0
  298. compas/scene/volmeshobject.py +252 -0
  299. compas/tolerance.py +879 -0
  300. compas/topology/__init__.py +45 -0
  301. compas/topology/combinatorics.py +108 -0
  302. compas/topology/connectivity.py +129 -0
  303. compas/topology/orientation.py +204 -0
  304. compas/topology/traversal.py +567 -0
  305. compas/utilities/__init__.py +25 -0
  306. compas/utilities/azync.py +155 -0
  307. compas/utilities/datetime.py +40 -0
  308. compas/utilities/decorators.py +136 -0
  309. compas/utilities/remote.py +54 -0
  310. compas/utilities/ssh.py +169 -0
  311. compas-2.1.1.dist-info/AUTHORS.md +42 -0
  312. compas-2.1.1.dist-info/LICENSE +21 -0
  313. compas-2.1.1.dist-info/METADATA +132 -0
  314. compas-2.1.1.dist-info/RECORD +468 -0
  315. compas-2.1.1.dist-info/WHEEL +5 -0
  316. compas-2.1.1.dist-info/entry_points.txt +2 -0
  317. compas-2.1.1.dist-info/top_level.txt +4 -0
  318. compas_blender/__init__.py +250 -0
  319. compas_blender/collections.py +130 -0
  320. compas_blender/conversions/__init__.py +48 -0
  321. compas_blender/conversions/breps.py +0 -0
  322. compas_blender/conversions/colors.py +23 -0
  323. compas_blender/conversions/curves.py +125 -0
  324. compas_blender/conversions/geometry.py +161 -0
  325. compas_blender/conversions/meshes.py +148 -0
  326. compas_blender/conversions/surfaces.py +48 -0
  327. compas_blender/conversions/transformations.py +46 -0
  328. compas_blender/data.py +30 -0
  329. compas_blender/geometry/__init__.py +14 -0
  330. compas_blender/geometry/booleans.py +100 -0
  331. compas_blender/install.py +338 -0
  332. compas_blender/objects.py +326 -0
  333. compas_blender/print_python_path.py +18 -0
  334. compas_blender/scene/__init__.py +116 -0
  335. compas_blender/scene/boxobject.py +64 -0
  336. compas_blender/scene/capsuleobject.py +73 -0
  337. compas_blender/scene/circleobject.py +53 -0
  338. compas_blender/scene/coneobject.py +70 -0
  339. compas_blender/scene/curveobject.py +58 -0
  340. compas_blender/scene/cylinderobject.py +70 -0
  341. compas_blender/scene/frameobject.py +105 -0
  342. compas_blender/scene/graphobject.py +257 -0
  343. compas_blender/scene/lineobject.py +60 -0
  344. compas_blender/scene/meshobject.py +508 -0
  345. compas_blender/scene/planeobject.py +81 -0
  346. compas_blender/scene/pointcloudobject.py +67 -0
  347. compas_blender/scene/pointobject.py +71 -0
  348. compas_blender/scene/polygonobject.py +57 -0
  349. compas_blender/scene/polyhedronobject.py +57 -0
  350. compas_blender/scene/polylineobject.py +54 -0
  351. compas_blender/scene/sceneobject.py +249 -0
  352. compas_blender/scene/sphereobject.py +72 -0
  353. compas_blender/scene/surfaceobject.py +54 -0
  354. compas_blender/scene/torusobject.py +73 -0
  355. compas_blender/scene/vectorobject.py +69 -0
  356. compas_blender/scene/volmeshobject.py +475 -0
  357. compas_blender/utilities/__init__.py +38 -0
  358. compas_blender/utilities/drawing.py +768 -0
  359. compas_ghpython/__init__.py +124 -0
  360. compas_ghpython/components/Compas_FromJson/code.py +18 -0
  361. compas_ghpython/components/Compas_Info/code.py +15 -0
  362. compas_ghpython/components/Compas_RpcCall/code.py +31 -0
  363. compas_ghpython/components/Compas_ToJson/code.py +19 -0
  364. compas_ghpython/components/Compas_ToRhinoGeometry/code.py +15 -0
  365. compas_ghpython/components/__init__.py +99 -0
  366. compas_ghpython/install.py +29 -0
  367. compas_ghpython/scene/__init__.py +115 -0
  368. compas_ghpython/scene/boxobject.py +40 -0
  369. compas_ghpython/scene/brepobject.py +40 -0
  370. compas_ghpython/scene/capsuleobject.py +41 -0
  371. compas_ghpython/scene/circleobject.py +40 -0
  372. compas_ghpython/scene/coneobject.py +40 -0
  373. compas_ghpython/scene/curveobject.py +42 -0
  374. compas_ghpython/scene/cylinderobject.py +38 -0
  375. compas_ghpython/scene/ellipseobject.py +40 -0
  376. compas_ghpython/scene/frameobject.py +67 -0
  377. compas_ghpython/scene/graphobject.py +77 -0
  378. compas_ghpython/scene/lineobject.py +39 -0
  379. compas_ghpython/scene/meshobject.py +137 -0
  380. compas_ghpython/scene/planeobject.py +61 -0
  381. compas_ghpython/scene/pointobject.py +38 -0
  382. compas_ghpython/scene/polygonobject.py +48 -0
  383. compas_ghpython/scene/polyhedronobject.py +48 -0
  384. compas_ghpython/scene/polylineobject.py +39 -0
  385. compas_ghpython/scene/sceneobject.py +12 -0
  386. compas_ghpython/scene/sphereobject.py +39 -0
  387. compas_ghpython/scene/surfaceobject.py +42 -0
  388. compas_ghpython/scene/torusobject.py +39 -0
  389. compas_ghpython/scene/vectorobject.py +51 -0
  390. compas_ghpython/scene/volmeshobject.py +154 -0
  391. compas_ghpython/sets.py +83 -0
  392. compas_ghpython/timer.py +36 -0
  393. compas_ghpython/uninstall.py +31 -0
  394. compas_ghpython/utilities/__init__.py +33 -0
  395. compas_ghpython/utilities/drawing.py +457 -0
  396. compas_rhino/__init__.py +607 -0
  397. compas_rhino/conduits/__init__.py +16 -0
  398. compas_rhino/conduits/base.py +121 -0
  399. compas_rhino/conduits/faces.py +91 -0
  400. compas_rhino/conduits/labels.py +102 -0
  401. compas_rhino/conduits/lines.py +109 -0
  402. compas_rhino/conduits/points.py +111 -0
  403. compas_rhino/conversions/__init__.py +168 -0
  404. compas_rhino/conversions/breps.py +122 -0
  405. compas_rhino/conversions/curves.py +453 -0
  406. compas_rhino/conversions/docobjects.py +0 -0
  407. compas_rhino/conversions/exceptions.py +7 -0
  408. compas_rhino/conversions/extrusions.py +80 -0
  409. compas_rhino/conversions/geometry.py +187 -0
  410. compas_rhino/conversions/meshes.py +281 -0
  411. compas_rhino/conversions/shapes.py +291 -0
  412. compas_rhino/conversions/surfaces.py +355 -0
  413. compas_rhino/conversions/transformations.py +45 -0
  414. compas_rhino/geometry/__init__.py +44 -0
  415. compas_rhino/geometry/booleans.py +118 -0
  416. compas_rhino/geometry/brep/__init__.py +40 -0
  417. compas_rhino/geometry/brep/brep.py +554 -0
  418. compas_rhino/geometry/brep/builder.py +184 -0
  419. compas_rhino/geometry/brep/edge.py +202 -0
  420. compas_rhino/geometry/brep/face.py +285 -0
  421. compas_rhino/geometry/brep/loop.py +129 -0
  422. compas_rhino/geometry/brep/trim.py +99 -0
  423. compas_rhino/geometry/brep/vertex.py +76 -0
  424. compas_rhino/geometry/curves/__init__.py +43 -0
  425. compas_rhino/geometry/curves/curve.py +382 -0
  426. compas_rhino/geometry/curves/nurbs.py +298 -0
  427. compas_rhino/geometry/surfaces/__init__.py +50 -0
  428. compas_rhino/geometry/surfaces/nurbs.py +370 -0
  429. compas_rhino/geometry/surfaces/surface.py +407 -0
  430. compas_rhino/geometry/trimesh_curvature.py +344 -0
  431. compas_rhino/geometry/trimesh_slicing.py +65 -0
  432. compas_rhino/install.py +382 -0
  433. compas_rhino/install_plugin.py +169 -0
  434. compas_rhino/install_with_pip.py +20 -0
  435. compas_rhino/layers.py +347 -0
  436. compas_rhino/objects.py +1141 -0
  437. compas_rhino/print_python_path.py +18 -0
  438. compas_rhino/scene/__init__.py +123 -0
  439. compas_rhino/scene/boxobject.py +44 -0
  440. compas_rhino/scene/brepobject.py +41 -0
  441. compas_rhino/scene/capsuleobject.py +45 -0
  442. compas_rhino/scene/circleobject.py +43 -0
  443. compas_rhino/scene/coneobject.py +43 -0
  444. compas_rhino/scene/curveobject.py +43 -0
  445. compas_rhino/scene/cylinderobject.py +43 -0
  446. compas_rhino/scene/ellipseobject.py +44 -0
  447. compas_rhino/scene/frameobject.py +99 -0
  448. compas_rhino/scene/graphobject.py +364 -0
  449. compas_rhino/scene/helpers.py +33 -0
  450. compas_rhino/scene/lineobject.py +43 -0
  451. compas_rhino/scene/meshobject.py +673 -0
  452. compas_rhino/scene/planeobject.py +71 -0
  453. compas_rhino/scene/pointobject.py +43 -0
  454. compas_rhino/scene/polygonobject.py +45 -0
  455. compas_rhino/scene/polyhedronobject.py +45 -0
  456. compas_rhino/scene/polylineobject.py +43 -0
  457. compas_rhino/scene/sceneobject.py +123 -0
  458. compas_rhino/scene/sphereobject.py +43 -0
  459. compas_rhino/scene/surfaceobject.py +42 -0
  460. compas_rhino/scene/torusobject.py +43 -0
  461. compas_rhino/scene/vectorobject.py +49 -0
  462. compas_rhino/scene/volmeshobject.py +518 -0
  463. compas_rhino/ui.py +114 -0
  464. compas_rhino/uninstall.py +243 -0
  465. compas_rhino/uninstall_plugin.py +91 -0
  466. compas_rhino/utilities/__init__.py +37 -0
  467. compas_rhino/utilities/constructors.py +71 -0
  468. compas_rhino/utilities/drawing.py +1081 -0
@@ -0,0 +1,181 @@
1
+ from __future__ import absolute_import
2
+ from __future__ import division
3
+ from __future__ import print_function
4
+
5
+ import importlib
6
+ import json
7
+ import pstats
8
+ import sys
9
+ import traceback
10
+
11
+ from compas.data import DataDecoder
12
+ from compas.data import DataEncoder
13
+
14
+ try:
15
+ from cStringIO import StringIO
16
+ except ImportError:
17
+ try:
18
+ from StringIO import StringIO
19
+ except ImportError:
20
+ from io import StringIO
21
+
22
+ try:
23
+ from cProfile import Profile
24
+ except ImportError:
25
+ from profile import Profile
26
+
27
+
28
+ class Dispatcher(object):
29
+ """Base class for remote services.
30
+
31
+ Notes
32
+ -----
33
+ This object is used to dispatch API calls to the corresponding functions or methods.
34
+ Since it is run on the server side, all errors are intercepted and their
35
+ message strings assigned to the `'error'` key of the output dictionary
36
+ such that the errors can be rethrown on the client side.
37
+
38
+ """
39
+
40
+ def on_module_imported(self, module, newly_loaded_modules):
41
+ """Event triggered when a module is successfully imported.
42
+
43
+ Override this method when subclassing in order to handle the what happens
44
+ after a module has been imported.
45
+
46
+ Parameters
47
+ ----------
48
+ module : module
49
+ A module object.
50
+ newly_loaded_modules : sequence[str]
51
+ A list of module names that have been loaded.
52
+
53
+ Returns
54
+ -------
55
+ None
56
+
57
+ """
58
+ pass
59
+
60
+ def _dispatch(self, name, args):
61
+ """Dispatcher method for XMLRPC API calls.
62
+
63
+ This method is automatically called by the XMLRPC server if an instance
64
+ of the dispatcher is registered with the server and the API call dies not
65
+ correspond to a method of the server itself, or of an explicilty registered
66
+ function.
67
+
68
+ Parameters
69
+ ----------
70
+ name : str
71
+ Name of the function.
72
+ args : list
73
+ List of positional arguments.
74
+ The first argument in the list should be the JSON serialized string
75
+ representation of the input dictionary. The structure of the input
76
+ dictionary is defined by the caller.
77
+
78
+ Returns
79
+ -------
80
+ str
81
+ A JSON serialized string representation of the output dictionary.
82
+ The output dictionary has the following structure:
83
+
84
+ * `'data'` : The returned result of the function call.
85
+ * `'error'` : The error message of any error that may have been thrown in the processes of dispatching to or execution of the API function.
86
+ * `'profile'` : A profile of the function execution.
87
+
88
+ """
89
+ odict = {"data": None, "error": None, "profile": None}
90
+
91
+ if len(args) > 1:
92
+ if args[1] not in sys.path:
93
+ sys.path.insert(0, args[1])
94
+
95
+ parts = name.split(".")
96
+
97
+ functionname = parts[-1]
98
+
99
+ try:
100
+ if len(parts) > 1:
101
+ modulename = ".".join(parts[:-1])
102
+
103
+ modules_before_import = set(sys.modules.keys())
104
+
105
+ # Trigger import
106
+ module = importlib.import_module(modulename)
107
+
108
+ newly_loaded_modules = set(sys.modules.keys()) - modules_before_import
109
+ self.on_module_imported(module, newly_loaded_modules)
110
+ else:
111
+ module = self
112
+ except Exception:
113
+ odict["error"] = traceback.format_exc()
114
+
115
+ else:
116
+ try:
117
+ function = getattr(module, functionname)
118
+ except AttributeError:
119
+ odict["error"] = "This function is not part of the API: {0}".format(functionname)
120
+
121
+ else:
122
+ try:
123
+ idict = json.loads(args[0], cls=DataDecoder)
124
+ except (IndexError, TypeError):
125
+ odict["error"] = "API methods require a single JSON encoded dictionary as input.\n" "For example: input = json.dumps({'param_1': 1, 'param_2': [2, 3]})"
126
+
127
+ else:
128
+ self._call(function, idict, odict)
129
+
130
+ return json.dumps(odict, cls=DataEncoder)
131
+
132
+ def _call(self, function, idict, odict):
133
+ """Method that handles the actual call to the function corresponding to the API call.
134
+
135
+ Parameters
136
+ ----------
137
+ function : callable
138
+ The callable object corresponding to the requested API call.
139
+ idict : dict
140
+ The input dictionary.
141
+ odict : dict
142
+ The output dictionary.
143
+
144
+ Notes
145
+ -----
146
+ The output dictionary will be modified in place.
147
+
148
+ """
149
+ args = idict["args"]
150
+ kwargs = idict["kwargs"]
151
+
152
+ try:
153
+ data = function(*args, **kwargs)
154
+ except Exception:
155
+ odict["error"] = traceback.format_exc()
156
+ else:
157
+ odict["data"] = data
158
+
159
+ def _call_wrapped(self, function, idict, odict):
160
+ """Does the same as _call, but with profiling enabled."""
161
+ args = idict["args"]
162
+ kwargs = idict["kwargs"]
163
+
164
+ try:
165
+ profile = Profile()
166
+ profile.enable()
167
+
168
+ data = function(*args, **kwargs)
169
+
170
+ profile.disable()
171
+ stream = StringIO()
172
+ stats = pstats.Stats(profile, stream=stream)
173
+ stats.strip_dirs()
174
+ stats.sort_stats(1)
175
+ stats.print_stats(20)
176
+
177
+ except Exception:
178
+ odict["error"] = traceback.format_exc()
179
+ else:
180
+ odict["data"] = data
181
+ odict["profile"] = stream.getvalue()
compas/rpc/errors.py ADDED
@@ -0,0 +1,11 @@
1
+ from __future__ import absolute_import
2
+ from __future__ import division
3
+ from __future__ import print_function
4
+
5
+
6
+ class RPCServerError(Exception):
7
+ """Exception for errors originating from the server."""
8
+
9
+
10
+ class RPCClientError(Exception):
11
+ """Exception for errors originating from the client."""
compas/rpc/proxy.py ADDED
@@ -0,0 +1,437 @@
1
+ from __future__ import absolute_import
2
+ from __future__ import division
3
+ from __future__ import print_function
4
+
5
+ import json
6
+ import time
7
+
8
+ import compas
9
+ import compas._os
10
+ from compas.data import DataDecoder
11
+ from compas.data import DataEncoder
12
+ from compas.rpc import RPCServerError
13
+
14
+ try:
15
+ from xmlrpclib import ServerProxy
16
+ except ImportError:
17
+ from xmlrpc.client import ServerProxy
18
+
19
+ try:
20
+ from subprocess import PIPE
21
+ from subprocess import Popen
22
+ except ImportError:
23
+ from System.Diagnostics import Process
24
+
25
+
26
+ class Proxy(object):
27
+ """Create a proxy object as intermediary between client code and remote functionality.
28
+
29
+ This class is a context manager, so when used in a ``with`` statement,
30
+ it ensures the remote proxy server is stopped and disposed correctly.
31
+
32
+ However, if the proxy server is left open, it can be re-used for a follow-up connection,
33
+ saving start up time.
34
+
35
+ Parameters
36
+ ----------
37
+ package : str, optional
38
+ The base package for the requested functionality.
39
+ Default is None, in which case a full path to function calls should be provided.
40
+ python : str, optional
41
+ The python executable that should be used to execute the code.
42
+ url : str, optional
43
+ The server address.
44
+ port : int, optional
45
+ The port number on the remote server.
46
+ service : str, optional
47
+ Package name to start server.
48
+ Default is ``'compas.rpc.services.default'``.
49
+ max_conn_attempts: int, optional
50
+ Amount of attempts to connect to RPC server before time out.
51
+ autoreload : bool, optional
52
+ If True, automatically reload the proxied package if changes are detected.
53
+ This is particularly useful during development. The server will monitor changes to the files
54
+ that were loaded as a result of accessing the specified `package` and if any change is detected,
55
+ it will unload the module, so that the next invocation uses a fresh version.
56
+ capture_output : bool, optional
57
+ If True, capture the stdout/stderr output of the remote process.
58
+ In general, `capture_output` should be True when using a `pythonw` as executable (default).
59
+ path : str, optional
60
+ Path to the folder containing the module to be proxied.
61
+ This is useful for cases where the module to be proxied is not on the PYTHONPATH.
62
+ working_directory : str, optional
63
+ Current working directory for the process that will be started to run the server.
64
+ This is useful for cases where a custom service is used and the service is not on the PYTHONPATH.
65
+
66
+ Attributes
67
+ ----------
68
+ address : str, read-only
69
+ Address of the server as a combination of `url` and `port`.
70
+ profile : str
71
+ A profile of the code executed by the server.
72
+ package : str
73
+ Fully qualified name of the package or module
74
+ from where functions should be imported on the server side.
75
+ service : str
76
+ Fully qualified package name required for starting the server/service.
77
+ python : str
78
+ The type of Python executable that should be used to execute the code.
79
+
80
+ Notes
81
+ -----
82
+ If the server is your *localhost*, which will often be the case, it is better
83
+ to specify the address explicitly (``'http://127.0.0.1'``) because resolving
84
+ *localhost* takes a surprisingly significant amount of time.
85
+
86
+ The service will make the correct (version of the requested) functionality available
87
+ even if that functionality is part of a virtual environment. This is because it
88
+ will use the specific python interpreter for which the functionality is installed to
89
+ start the server.
90
+
91
+ If possible, the proxy will try to reconnect to an already existing service
92
+
93
+ Examples
94
+ --------
95
+ Minimal example showing connection to the proxy server, and ensuring the
96
+ server is disposed after using it:
97
+
98
+ >>> from compas.rpc import Proxy # doctest: +SKIP
99
+ >>> with Proxy("compas.numerical") as numerical: # doctest: +SKIP
100
+ ... pass # doctest: +SKIP
101
+ ... # doctest: +SKIP
102
+ Starting a new proxy server... # doctest: +SKIP
103
+ New proxy server started. # doctest: +SKIP
104
+ Stopping the server proxy. # doctest: +SKIP
105
+ """
106
+
107
+ def __init__(
108
+ self,
109
+ package=None,
110
+ python=None,
111
+ url="http://127.0.0.1",
112
+ port=1753,
113
+ service=None,
114
+ max_conn_attempts=100,
115
+ autoreload=True,
116
+ capture_output=True,
117
+ path=None,
118
+ working_directory=None,
119
+ ):
120
+ self._package = None
121
+ self._python = compas._os.select_python(python)
122
+ self._url = url
123
+ self._port = port
124
+ self.max_conn_attempts = max_conn_attempts
125
+ self._service = None
126
+ self._process = None
127
+ self._function = None
128
+ self._profile = None
129
+ self._path = path
130
+ self._working_directory = working_directory
131
+
132
+ self.service = service
133
+ self.package = package
134
+ self.autoreload = autoreload
135
+ self.capture_output = capture_output
136
+
137
+ self._implicitely_started_server = False
138
+ self._server = self._try_reconnect()
139
+ if self._server is None:
140
+ self._server = self.start_server()
141
+ self._implicitely_started_server = True
142
+
143
+ # ==========================================================================
144
+ # properties
145
+ # ==========================================================================
146
+
147
+ @property
148
+ def address(self):
149
+ return "{}:{}".format(self._url, self._port)
150
+
151
+ @property
152
+ def profile(self):
153
+ return self._profile
154
+
155
+ @profile.setter
156
+ def profile(self, profile):
157
+ self._profile = profile
158
+
159
+ @property
160
+ def package(self):
161
+ return self._package
162
+
163
+ @package.setter
164
+ def package(self, package):
165
+ self._package = package
166
+
167
+ @property
168
+ def service(self):
169
+ return self._service
170
+
171
+ @service.setter
172
+ def service(self, service):
173
+ if not service:
174
+ self._service = "compas.rpc.services.default"
175
+ else:
176
+ self._service = service
177
+
178
+ @property
179
+ def python(self):
180
+ return self._python
181
+
182
+ @python.setter
183
+ def python(self, python):
184
+ self._python = python
185
+
186
+ # ==========================================================================
187
+ # customization
188
+ # ==========================================================================
189
+
190
+ def __enter__(self):
191
+ return self
192
+
193
+ def __exit__(self, *args):
194
+ # If we started the RPC server, we will try to clean up and stop it
195
+ # otherwise we just disconnect from it
196
+ if self._implicitely_started_server:
197
+ self.stop_server()
198
+ else:
199
+ self._server.__close()
200
+
201
+ def __getattr__(self, name):
202
+ """Find server attributes (methods) corresponding to attributes that do not exist on the proxy itself.
203
+
204
+ 1. Use :attr:`package` as a namespace for the requested attribute to create a fully qualified path on the server.
205
+ 2. Try to get the fully qualified attribute from :attr:`_server`.
206
+ 3. If successful, store the result in :attr:`_function`.
207
+ 3. Return a handle to :meth:`_proxy`, which will delegate calls to :attr:`_function`.
208
+
209
+ Returns
210
+ -------
211
+ callable
212
+
213
+ """
214
+ if self.package:
215
+ name = "{}.{}".format(self.package, name)
216
+ try:
217
+ self._function = getattr(self._server, name)
218
+ except Exception:
219
+ raise RPCServerError()
220
+ return self._proxy
221
+
222
+ # ==========================================================================
223
+ # methods
224
+ # ==========================================================================
225
+
226
+ def _try_reconnect(self):
227
+ """Try and reconnect to an existing proxy server.
228
+
229
+ Returns
230
+ -------
231
+ ServerProxy
232
+ Instance of the proxy if reconnection succeeded, otherwise ``None``.
233
+
234
+ """
235
+ server = ServerProxy(self.address)
236
+ try:
237
+ server.ping()
238
+ except Exception:
239
+ return None
240
+ else:
241
+ print("Reconnecting to an existing server proxy.")
242
+ return server
243
+
244
+ def start_server(self):
245
+ """Start the remote server.
246
+
247
+ Returns
248
+ -------
249
+ ServerProxy
250
+ Instance of the proxy, if the connection was successful.
251
+
252
+ Raises
253
+ ------
254
+ RPCServerError
255
+ If the server providing the requested service cannot be reached after
256
+ 100 contact attempts (*pings*). The number of attempts is set by
257
+ :attr:`Proxy.max_conn_attempts`.
258
+
259
+ Examples
260
+ --------
261
+ >>> p = Proxy() # doctest: +SKIP
262
+ >>> p.stop_server() # doctest: +SKIP
263
+ >>> p.start_server() # doctest: +SKIP
264
+
265
+ """
266
+ env = compas._os.prepare_environment()
267
+
268
+ # this part starts the server side of the RPC setup
269
+ # it basically launches a subprocess
270
+ # to start the default service
271
+ # the default service creates a server
272
+ # and registers a dispatcher for custom functionality
273
+ try:
274
+ Popen
275
+
276
+ except NameError:
277
+ self._process = Process()
278
+ for name in env:
279
+ if self._process.StartInfo.EnvironmentVariables.ContainsKey(name):
280
+ self._process.StartInfo.EnvironmentVariables[name] = env[name]
281
+ else:
282
+ self._process.StartInfo.EnvironmentVariables.Add(name, env[name])
283
+ self._process.StartInfo.UseShellExecute = False
284
+ self._process.StartInfo.RedirectStandardOutput = self.capture_output
285
+ self._process.StartInfo.RedirectStandardError = self.capture_output
286
+ self._process.StartInfo.FileName = self.python
287
+ self._process.StartInfo.Arguments = "-m {0} --port {1} --{2}autoreload".format(self.service, self._port, "" if self.autoreload else "no-")
288
+ self._process.Start()
289
+ else:
290
+ args = [
291
+ self.python,
292
+ "-m",
293
+ self.service,
294
+ "--port",
295
+ str(self._port),
296
+ "--{}autoreload".format("" if self.autoreload else "no-"),
297
+ ]
298
+ kwargs = dict(env=env)
299
+ if self.capture_output:
300
+ kwargs["stdout"] = PIPE
301
+ kwargs["stderr"] = PIPE
302
+ if self._working_directory:
303
+ kwargs["cwd"] = self._working_directory
304
+
305
+ self._process = Popen(args, **kwargs)
306
+
307
+ # this starts the client side
308
+ # it creates a proxy for the server
309
+ # and tries to connect the proxy to the actual server
310
+ server = ServerProxy(self.address)
311
+
312
+ print("Starting a new proxy server...")
313
+ success = False
314
+ attempt_count = 0
315
+ while attempt_count < self.max_conn_attempts:
316
+ try:
317
+ server.ping()
318
+ except Exception:
319
+ time.sleep(0.1)
320
+ attempt_count += 1
321
+ print(" {} attempts left.".format(self.max_conn_attempts - attempt_count))
322
+ else:
323
+ success = True
324
+ break
325
+
326
+ if not success:
327
+ raise RPCServerError("The server is not available.")
328
+ else:
329
+ print("New proxy server started.")
330
+
331
+ return server
332
+
333
+ def stop_server(self):
334
+ """Stop the remote server and terminate/kill the python process that was used to start it.
335
+
336
+ Returns
337
+ -------
338
+ None
339
+
340
+ Examples
341
+ --------
342
+ >>> p = Proxy() # doctest: +SKIP
343
+ >>> p.stop_server() # doctest: +SKIP
344
+ >>> p.start_server() # doctest: +SKIP
345
+
346
+ """
347
+ print("Stopping the server proxy.")
348
+ try:
349
+ self._server.remote_shutdown()
350
+ except Exception:
351
+ pass
352
+ self._terminate_process()
353
+
354
+ def restart_server(self):
355
+ """Restart the server.
356
+
357
+ Returns
358
+ -------
359
+ None
360
+
361
+ """
362
+ self.stop_server()
363
+ self.start_server()
364
+
365
+ def _terminate_process(self):
366
+ """Attempts to terminate the python process hosting the proxy server.
367
+
368
+ The process reference might not be present, e.g. in the case
369
+ of reusing an existing connection. In that case, this is a no-op.
370
+ """
371
+ if not self._process:
372
+ return
373
+ try:
374
+ self._process.terminate()
375
+ except Exception:
376
+ pass
377
+ try:
378
+ self._process.kill()
379
+ except Exception:
380
+ pass
381
+
382
+ def _proxy(self, *args, **kwargs):
383
+ """Callable replacement for the requested functionality.
384
+
385
+ Parameters
386
+ ----------
387
+ *args : list
388
+ Positional arguments to be passed to the remote function.
389
+ **kwargs : dict, optional
390
+ Named arguments to be passed to the remote function.
391
+
392
+ Returns
393
+ -------
394
+ object
395
+ The 'data' part of the result dict returned by the remote function.
396
+ The result dict has the following structure ::
397
+
398
+ {
399
+ "error": ..., # A traceback of the error raised on the server, if any.
400
+ "profile": ..., # A profile of the code executed on the server, if there was no error.
401
+ "data": ..., # The result returned by the target function, if there was no error.
402
+ }
403
+
404
+ Warnings
405
+ --------
406
+ The `args` and `kwargs` have to be JSON-serializable.
407
+ This means that, currently, only COMPAS data objects (geometry, robots, data structures) and native Python objects are supported.
408
+ The returned results will also always be in the form of COMPAS data objects and built-in Python objects.
409
+ Numpy objects are automatically converted to their built-in Python equivalents.
410
+
411
+ """
412
+ idict = {"args": args, "kwargs": kwargs}
413
+ istring = json.dumps(idict, cls=DataEncoder)
414
+ # it makes sense that there is a broken pipe error
415
+ # because the process is not the one receiving the feedback
416
+ # when there is a print statement on the server side
417
+ # this counts as output
418
+ # it should be sent as part of RPC communication
419
+ try:
420
+ ostring = self._function(istring, self._path or "")
421
+ except Exception:
422
+ # not clear what the point of this is
423
+ # self.stop_server()
424
+ # if this goes wrong, it means a Fault error was generated by the server
425
+ # no need to stop the server for this
426
+ raise
427
+
428
+ if not ostring:
429
+ raise RPCServerError("No output was generated.")
430
+
431
+ result = json.loads(ostring, cls=DataDecoder)
432
+
433
+ if result["error"]:
434
+ raise RPCServerError(result["error"])
435
+
436
+ self.profile = result["profile"]
437
+ return result["data"]
compas/rpc/server.py ADDED
@@ -0,0 +1,79 @@
1
+ from __future__ import absolute_import
2
+ from __future__ import division
3
+ from __future__ import print_function
4
+
5
+ import threading
6
+
7
+ try:
8
+ from SimpleXMLRPCServer import SimpleXMLRPCServer
9
+ except ImportError:
10
+ from xmlrpc.server import SimpleXMLRPCServer
11
+
12
+
13
+ class Server(SimpleXMLRPCServer):
14
+ """Version of a `SimpleXMLRPCServer` that can be cleanly terminated from the client side.
15
+
16
+ Notes
17
+ -----
18
+ This class has to be used by a service to start the XMLRPC server in a way
19
+ that can be pinged to check if the server is alive, and can be cleanly terminated.
20
+
21
+ Examples
22
+ --------
23
+ .. code-block:: python
24
+
25
+ # service.py
26
+
27
+ from compas.rpc import Server
28
+ from compas.rpc import Dispatcher
29
+
30
+
31
+ class DefaultService(Dispatcher):
32
+ pass
33
+
34
+
35
+ if __name__ == "__main__":
36
+ server = Server(("localhost", 8888))
37
+
38
+ server.register_function(server.ping)
39
+ server.register_function(server.remote_shutdown)
40
+ server.register_instance(DefaultService())
41
+ server.serve_forever()
42
+
43
+ """
44
+
45
+ def __init__(self, address, *args, **kwargs):
46
+ super(Server, self).__init__(address, *args, **kwargs)
47
+ self.register_function(self.ping)
48
+ self.register_function(self.remote_shutdown)
49
+
50
+ def ping(self):
51
+ """Simple function used to check if a remote server can be reached.
52
+
53
+ Returns
54
+ -------
55
+ int
56
+ Always returns 1, since the ping is considered a success
57
+ if the function can be reached from the client.
58
+
59
+ Notes
60
+ -----
61
+ Should be used together with an instance of `compas.rpc.Server`.
62
+
63
+ """
64
+ return 1
65
+
66
+ def remote_shutdown(self):
67
+ """Stop the server through a call from the client side.
68
+
69
+ Returns
70
+ -------
71
+ int
72
+ Always returns 1.
73
+
74
+ """
75
+ threading.Thread(target=self._shutdown_thread).start()
76
+ return 1
77
+
78
+ def _shutdown_thread(self):
79
+ self.shutdown()
File without changes