Readme rework draft #163

goodboy · 2020-10-16T17:11:26Z

TODO:

a definitive example once Allow passing function refs to Portal.run() ? #69 lands
~~[ ] the equivalent output from $TERM -e watch -n 0.1 "pstree -a $$" & python examples/parallelism/we_are_processes.py && kill $!~~ we stuck the command in the examples which I think is good enough for now.
~~- [ ] maybe a .gif of the above bullet?~~ deferred to Should we add a .gif to the readme? #199

Do we need the gifs?
I'm fine to add them later if peeps insist.

Defer to "branding" PR?:

a logo re: Add logo and github actions badge to readme #153
~~- [ ] someone to pump our .dev0 release somewhere (cuz I ain't doin it)~~ defer to Pump eet? #2

Defer to docs rework PR (the readme should be simple)

~~- [ ] add some process tree diagrams using both something like mermaid.io and output from pstree?~~ deferred to #157

ryanhiebert · 2020-10-16T17:28:04Z

README.rst

@@ -1,6 +1,7 @@
 tractor
 =======
 A `structured concurrent`_, async-native "`actor model`_" built on trio_ and multiprocessing_.


This looks pretty good to me. If I were you, I'd want to decouple my pitch for tractor from multiprocessing, and leave that as an implementation detail.

@ryanhiebert it links to wikipedia not the stdlib; so it's in reference to actual muli-processing as an OS usage pattern.

Not sure if that was clear. Maybe multi-processing (with the dash) makes that more clear?

If you just mean that not focusing on it being implemented with multiple processes (since in theory we could somehow move to a threading system eventually?) then definitely worth considering.

Oh, I was thinking it was about the stdlib module. The dash would make more sense to me.

Yeah, the plan is to move entirely off the stdlib module asap.

The only thing blocking that is #146 for which I'd like to keep the stdlib stuff to compare against.

goodboy · 2020-10-23T15:24:45Z

@ryanhiebert btw there's a matrix room now for the project if you feel like joining us.

goodboy · 2020-11-26T21:43:39Z

I think I figured out we can make a pretty simple "worker pool" example to address the first todo once #69 comes.

Something along the lines of a round-robin request-response pool; real simple.

Just sticking this comment as reminder for meself.

chrizzFTD

Proposed README updates look good to me, thanks @goodboy !

I want to come back and try the examples and a bit more in the coming weeks on Windows 😃

chrizzFTD · 2020-12-01T13:20:38Z

tractor/to_asyncio.py

+    try:
+        import uvloop
+        loop = uvloop.new_event_loop()
+        asyncio.set_event_loop(loop)


Minor, but the helper uvloop.install() exists. I'm unsure of any actual difference, though.

Thanks v gtk.

chrizzFTD · 2020-12-01T13:23:10Z

README.rst

+or simply as a replacement for the stdlib's `multiprocessing` but built
+on async primitives for IPC.
+
+``tractor``'s nurseries lets you spawn ``trio`` *"actors"*: new Python


Super nitpicky, but I think nurseries let you (instead of lets) is the correct grammar?

Pretty sure this is fixed now.

chrizzFTD · 2020-12-01T13:23:33Z

README.rst

+-----------------
+- Infinitely nesteable process trees
+- A built-in API for inter-process streaming
+- A (first ever?) "native" multi-core debugger for Python using `pdb++`_


Excited to try this soon!

goodboy · 2020-12-09T16:00:15Z

Further things todo:

add some process tree diagrams using both something like mermaid.io and
the equivalent output from pstree -a $(pgrep <tractorprog>)
maybe a .gif of the above bullet?

EDIT

moving these to above list.

goodboy · 2020-12-09T22:37:38Z

For the worker pool example I'm thinking we might as well re-do the concurrent.futures prime number example so that peeps have a cross reference for what the insides of a ProcessPoolExecutor looks like implemented in tractor.

goodboy · 2021-02-24T05:03:09Z

Latest. hopefully final rework is up!

McSinyx

Coming from the trio room on Matrix: I was wrong about the empty line after the headings though.

McSinyx · 2021-02-24T08:31:56Z

docs/README.rst

+.. code:: python
+
+    """


Per the reST specs,

Several constructs begin with a marker, and the body of the construct
must be indented relative to the marker.

where in this case, the code-block (I can't seem to find code even in Sphinx-flavored reST) body should be indented by 3 space. I believe that the editor picked this up and caused some indentation issues below.

Oh so you mean after the .. there should be 3 spaces before the code::?

Yep, e.g.

.. code-block:: python """ ... async def target(): try: ...

BTW could you please hide the resolved reviews, my international connection is terrible due to cable maintenance or something and GitHub's way of fetching content really does not help 😄

McSinyx · 2021-02-24T08:32:43Z

docs/README.rst

+       await trio.sleep_forever()
+
+
+    async def main():
+
+       async with tractor.open_nursery() as n:


Nice catch. Fixing all this.

McSinyx · 2021-02-24T08:33:23Z

docs/README.rst

+    if __name__ == '__main__':
+       try:


Here as well.

goodboy · 2021-02-24T14:15:34Z

@guilledk yeah not sure what's going on with that worker pool link.
Code looks right now?

goodboy · 2021-02-24T14:16:01Z

docs/README.rst

+is ``tractor``'s IPC!
+
+
+.. _concurrent_actors_primes: https://github.com/goodboy/tractor/blob/master/examples/parallelism/concurrent_actors_primes.py


@guilledk not sure why it's not working?

This might be it:
https://sublime-and-sphinx-guide.readthedocs.io/en/latest/references.html#use-custom-link-text

Do not include a space between the last word of the link text and the opening angle bracket for the anchor text.

Lol nope nm.

Yeah no idea. The code looks right -> seems to be some GH thing.

goodboy · 2021-02-24T16:51:44Z

Lol, well turns out CI did in fact find a bug due to #185.

It appears that debug_mode=True isn't triggering crash handling in the root process only when not explicitly using the async with open_root_actor() entry-point; with the implicit runtime, errors caught in the root actor aren't being bubbled into the wrapping AsyncExitStack when using async with tractor.open_nursery().

I'm going to pull out the commit that introduced this change to the debugging example, move that history to a new branch + PR along with changes to port all the debugging examples to the new API.

@richardsheridan

Thanks to @richardsheridan for many suggestions!

goodboy requested review from chrizzFTD, guilledk, ryanhiebert and salotz October 16, 2020 17:11

ryanhiebert approved these changes Oct 16, 2020

View reviewed changes

goodboy force-pushed the readme_pump branch from c14a2b2 to ec5b0f0 Compare October 16, 2020 17:41

goodboy changed the base branch from master to infect_asyncio October 16, 2020 17:55

guilledk approved these changes Oct 17, 2020

View reviewed changes

goodboy force-pushed the infect_asyncio branch from b5cac1f to e637d9d Compare November 16, 2020 15:08

chrizzFTD approved these changes Dec 1, 2020

View reviewed changes

goodboy force-pushed the readme_pump branch 3 times, most recently from 96daab2 to dd6271c Compare December 9, 2020 18:07

goodboy mentioned this pull request Dec 10, 2020

Worker pool API? #66

Open

goodboy force-pushed the readme_pump branch from dd6271c to 46aa596 Compare December 10, 2020 16:56

goodboy mentioned this pull request Dec 10, 2020

Pump eet? #2

Open

goodboy force-pushed the infect_asyncio branch 4 times, most recently from 900654e to 6d03000 Compare December 12, 2020 20:12

goodboy force-pushed the infect_asyncio branch from 6d03000 to df750a1 Compare December 19, 2020 17:36

goodboy mentioned this pull request Dec 20, 2020

Add Portal.run_func(): run local funcs remotely #105

Closed

goodboy force-pushed the infect_asyncio branch 4 times, most recently from f0a3b66 to 91d34c2 Compare December 25, 2020 20:36

McSinyx reviewed Feb 24, 2021

View reviewed changes

goodboy force-pushed the readme_pump branch from 420b6af to 75ce2e7 Compare February 24, 2021 14:14

goodboy commented Feb 24, 2021

View reviewed changes

goodboy force-pushed the readme_pump branch 2 times, most recently from 1626fae to 82ba680 Compare February 24, 2021 14:22

goodboy mentioned this pull request Feb 24, 2021

Revamp DOCS, fo realz #157

Open

13 tasks

goodboy mentioned this pull request Feb 24, 2021

Drop run #197

Merged

8 tasks

goodboy force-pushed the readme_pump branch 2 times, most recently from a347804 to 14ac7a9 Compare February 25, 2021 00:14

goodboy mentioned this pull request Feb 25, 2021

Kinda drop run #198

Merged

goodboy force-pushed the readme_pump branch from 14ac7a9 to 13790de Compare February 25, 2021 12:40

goodboy mentioned this pull request Feb 25, 2021

Add logo and github actions badge to readme #153

Closed

goodboy force-pushed the readme_pump branch from 13790de to 2f39461 Compare February 25, 2021 13:06

goodboy added 11 commits February 25, 2021 09:10

Readme rework draft

0a5a4d8

Further tweaks, add non-scary snippet

90c987d

Draft use sphinx-restbuilder to gen readme

92f4b40

Revert auto-gen readme and merge in auto-gen code blocks by hand for now

0e7db46

Compress terminal cmd line lens

4a512bc

Drop worker pool and add debug example

71a35aa

Add comma

0c8f9db

Attempt to add logo

f342c3a

Reorg and rejig flow

8ee9007

Thanks to @richardsheridan for many suggestions!

Fix code indent and worker pool link

ab19274

Further simplifications

0679eb5

goodboy force-pushed the readme_pump branch from 2f39461 to 0679eb5 Compare February 25, 2021 14:10

goodboy merged commit a0981be into master Feb 25, 2021

goodboy deleted the readme_pump branch February 25, 2021 14:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Readme rework draft #163

Readme rework draft #163

goodboy commented Oct 16, 2020 •

edited

ryanhiebert Oct 16, 2020

goodboy Oct 16, 2020

ryanhiebert Oct 16, 2020

goodboy Oct 16, 2020

goodboy commented Oct 23, 2020

goodboy commented Nov 26, 2020

chrizzFTD left a comment

chrizzFTD Dec 1, 2020

goodboy Dec 1, 2020

chrizzFTD Dec 1, 2020

goodboy Dec 21, 2020

chrizzFTD Dec 1, 2020

goodboy Dec 1, 2020

goodboy commented Dec 9, 2020 •

edited

goodboy commented Dec 9, 2020

goodboy commented Feb 24, 2021

McSinyx left a comment

McSinyx Feb 24, 2021

goodboy Feb 24, 2021 •

edited

McSinyx Feb 24, 2021

McSinyx Feb 24, 2021

goodboy Feb 24, 2021

McSinyx Feb 24, 2021

goodboy commented Feb 24, 2021

goodboy Feb 24, 2021

goodboy Feb 24, 2021

goodboy Feb 24, 2021

goodboy Feb 24, 2021

goodboy commented Feb 24, 2021

		is ``tractor``'s IPC!


		.. _concurrent_actors_primes: https://github.com/goodboy/tractor/blob/master/examples/parallelism/concurrent_actors_primes.py

Readme rework draft #163

Readme rework draft #163

Conversation

goodboy commented Oct 16, 2020 • edited

TODO:

Defer to "branding" PR?:

Defer to docs rework PR (the readme should be simple)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goodboy commented Oct 23, 2020

goodboy commented Nov 26, 2020

chrizzFTD left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goodboy commented Dec 9, 2020 • edited

EDIT

goodboy commented Dec 9, 2020

goodboy commented Feb 24, 2021

McSinyx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goodboy Feb 24, 2021 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goodboy commented Feb 24, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

goodboy commented Feb 24, 2021

goodboy commented Oct 16, 2020 •

edited

goodboy commented Dec 9, 2020 •

edited

goodboy Feb 24, 2021 •

edited