pikuri-core 0.0.4 → 0.0.6

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.
@@ -7,16 +7,20 @@ module Pikuri
7
7
  # Chokepoint for *all* subprocess spawning in pikuri. Forces a new
8
8
  # process group for each invocation, tracks pgids so descendants of
9
9
  # the direct child (commands backgrounded with +&+) can be cleaned
10
- # up at process exit, and captures combined stdout+stderr through a
11
- # single pipe.
10
+ # up at process exit. Two front doors: {.spawn} (combined
11
+ # stdout+stderr through a single pipe — the shell-command shape) and
12
+ # {.run} (stdin fed from a String or streamed from an IO, stdout
13
+ # redirected to a file, stderr captured — the filter shape).
12
14
  #
13
15
  # == Seam discipline
14
16
  #
15
17
  # All subprocess spawning in +lib/+ goes through {.spawn}. Direct
16
18
  # +Process.spawn+ / +Open3.*+ / +system+ / backticks anywhere in
17
19
  # +lib/+ are bugs. The convention is grep-enforceable:
18
- # +grep -rn 'Process\.spawn\|Open3\|system\|backtick' lib/+ should
19
- # only hit this file.
20
+ # +grep -rnE 'Process\.spawn|Open3\.|\bsystem\(' lib/+ should
21
+ # only hit this file (plus the comment in
22
+ # +pikuri-mcp/lib/pikuri/mcp/servers.rb+ explaining the MCP
23
+ # exception).
20
24
  #
21
25
  # == Timeouts are the caller's job
22
26
  #
@@ -47,10 +51,11 @@ module Pikuri
47
51
  #
48
52
  # == State is process-global
49
53
  #
50
- # One +@active+ Set and one +at_exit+ for the whole process. A
51
- # +Mutex+ guards register/prune/cleanup; v1 is single-threaded, so
52
- # this is more for the +at_exit+/register race than for current
53
- # callers.
54
+ # One +@active+ Set for the whole process, swept once at exit via
55
+ # {Pikuri::Finalizers} (see the registration at the bottom of this
56
+ # file). A +Mutex+ guards register/prune/cleanup; v1 is
57
+ # single-threaded, so this is more for the exit-sweep/register race
58
+ # than for current callers.
54
59
  #
55
60
  # == Why +Pikuri::Subprocess+, not top-level
56
61
  #
@@ -88,6 +93,75 @@ module Pikuri
88
93
  new(io: io, wait_thr: wait_thr)
89
94
  end
90
95
 
96
+ # Run +argv+ as a one-shot *filter*: feed it +stdin_data+, redirect
97
+ # its stdout straight to +stdout+ (an open +File+), capture stderr
98
+ # through a pipe, and block until it exits. Built for the
99
+ # stdin→markdown document converters (pikuri-extractors), where
100
+ # {.spawn}'s shape is wrong twice over: it closes the child's stdin
101
+ # immediately, and it merges stderr onto stdout — fatal when stdout
102
+ # *is* the payload and a converter's warnings would corrupt it.
103
+ #
104
+ # Redirecting stdout to a file (not a pipe) is also what makes the
105
+ # I/O deadlock-free with one writer thread: the child never blocks
106
+ # writing output, so it keeps draining stdin, while the parent
107
+ # drains the (low-volume) stderr pipe. The returned
108
+ # {Result#output} is the captured *stderr* — the diagnostics — not
109
+ # the payload; the payload is in +stdout+, whose file offset is
110
+ # shared with the child, so rewind before reading it back.
111
+ #
112
+ # Same discipline as {.spawn}: new process group, registered for
113
+ # the exit sweep, no built-in timeout (wrap +argv+ with coreutils'
114
+ # +timeout+ — see the class docs).
115
+ #
116
+ # @param argv [Array<String>] command and arguments, passed to
117
+ # +exec+ directly — no implicit shell.
118
+ # @param stdin_data [String, IO, StringIO] the child's stdin: a
119
+ # String is written as-is, an IO is streamed through
120
+ # +IO.copy_stream+ (so a large source file never materialises in
121
+ # the Ruby heap) and read from its current position. Either way
122
+ # stdin is closed (EOF) afterwards. May be empty.
123
+ # @param stdout [File] open writable file the child's stdout is
124
+ # redirected to.
125
+ # @param chdir [String, Pathname] working directory.
126
+ # @param env [Hash{String=>String}] extra environment variables,
127
+ # as for {.spawn}.
128
+ # @return [Result] +output+ is the captured stderr; +status+ the
129
+ # child's exit status.
130
+ # @raise [SystemCallError] whatever an IO +stdin_data+ raises
131
+ # mid-stream (disk error, closed handle) — re-raised here after
132
+ # the child has been reaped.
133
+ def self.run(*argv, stdin_data:, stdout:, chdir:, env: {})
134
+ in_r, in_w = IO.pipe
135
+ err_r, err_w = IO.pipe
136
+ pid = Process.spawn(env, *argv, chdir: chdir.to_s, pgroup: true,
137
+ in: in_r, out: stdout, err: err_w)
138
+ in_r.close
139
+ err_w.close
140
+ register(pid)
141
+ writer = Thread.new do
142
+ in_w.binmode
143
+ if stdin_data.respond_to?(:read)
144
+ IO.copy_stream(stdin_data, in_w)
145
+ else
146
+ in_w.write(stdin_data)
147
+ end
148
+ rescue Errno::EPIPE
149
+ nil # child exited without draining stdin; its status tells the story
150
+ ensure
151
+ in_w.close
152
+ end
153
+ stderr = err_r.read
154
+ err_r.close
155
+ # Reap before joining the writer: if an IO source raised
156
+ # mid-stream, #join re-raises it, and the child (already exited —
157
+ # err_r hit EOF) must not be left a zombie.
158
+ _, status = Process.waitpid2(pid)
159
+ writer.join
160
+ Result.new(output: stderr, status: status)
161
+ ensure
162
+ prune(pid) if pid
163
+ end
164
+
91
165
  # @return [Integer] direct child's pid
92
166
  attr_reader :pid
93
167
 
@@ -122,6 +196,23 @@ module Pikuri
122
196
  self.class.send(:prune, @pgid)
123
197
  end
124
198
 
199
+ # SIGTERM the whole process group without blocking for output —
200
+ # the stop button for a *daemon* child (one the caller never
201
+ # {#wait}s on, e.g. {Pikuri::Memory::Mem0Server}'s socat relay).
202
+ # Best-effort and idempotent: an already-dead group is a no-op.
203
+ # The group stays in the exit-sweep set until it actually dies,
204
+ # so a child that ignores SIGTERM is still re-signalled by
205
+ # {.cleanup!} at process exit.
206
+ #
207
+ # @return [void]
208
+ def terminate
209
+ Process.kill('-TERM', @pgid)
210
+ rescue Errno::ESRCH
211
+ # already gone
212
+ ensure
213
+ self.class.send(:prune, @pgid)
214
+ end
215
+
125
216
  class << self
126
217
  # Currently-tracked process groups, with dead ones pruned as a
127
218
  # side effect. Useful for a future +/bg+ REPL command or a
@@ -135,9 +226,9 @@ module Pikuri
135
226
  end
136
227
  end
137
228
 
138
- # SIGTERM every tracked process group. Used by +at_exit+
139
- # (production) and +after+ blocks (specs). Best-effort —
140
- # ignores errors from already-dead groups.
229
+ # SIGTERM every tracked process group. Run at process exit via
230
+ # {Pikuri::Finalizers} (production) and from +after+ blocks
231
+ # (specs). Best-effort — ignores errors from already-dead groups.
141
232
  #
142
233
  # @return [void]
143
234
  def cleanup!
@@ -170,4 +261,10 @@ module Pikuri
170
261
  end
171
262
  end
172
263
 
173
- at_exit { Pikuri::Subprocess.cleanup! }
264
+ # Registered at load (boot) — before any agent or server registers at
265
+ # construction time — so in {Pikuri::Finalizers}' LIFO sweep this runs
266
+ # LAST: graceful +#close+ on agents and servers first, then SIGTERM
267
+ # whatever child groups are still alive. The reaper, not a peer. (Was a
268
+ # standalone +at_exit+; routed through Finalizers so the order relative
269
+ # to every other teardown is controlled, not left to file load order.)
270
+ Pikuri::Finalizers.register { Pikuri::Subprocess.cleanup! }
@@ -1,63 +1,235 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'dentaku'
4
-
5
3
  module Pikuri
6
4
  class Tool
7
- # Evaluates a basic arithmetic expression using Dentaku, with light
8
- # preprocessing so the LLM can emit Python-flavored syntax (notably
9
- # +**+ for exponentiation) instead of learning Dentaku's dialect.
5
+ # Evaluates a basic arithmetic expression with Python operator
6
+ # syntax and semantics, via the hand-rolled recursive-descent
7
+ # {Parser} below.
8
+ #
9
+ # Why hand-rolled rather than a gem: the previous backend, dentaku,
10
+ # pulled in concurrent-ruby (~16k lines of Ruby — the single
11
+ # heaviest audit item in pikuri's whole dependency closure) plus
12
+ # bigdecimal and tsort, all to evaluate four-function arithmetic.
13
+ # The ~100 lines here implement Python's expression grammar
14
+ # directly, which also retires the old preprocessing step that
15
+ # rewrote Python's +**+ into dentaku's +^+ dialect — the model's
16
+ # native syntax is now simply the grammar.
10
17
  #
11
- # Scope is intentionally narrow: operators (+, -, *, /, **, %),
12
- # parentheses, and decimal numbers. No variables, functions, or
13
- # booleans — those would mean teaching the model a dialect, which we
14
- # specifically want to avoid for this tool.
18
+ # Scope is intentionally narrow: operators (+, -, *, /, //, %, **),
19
+ # unary minus, parentheses, and integer / decimal / e-notation
20
+ # literals. No variables, functions, or booleans — those would mean
21
+ # teaching the model a dialect, which we specifically want to avoid
22
+ # for this tool.
15
23
  module Calculator
16
- # Translate the operator differences between Python and Dentaku. In
17
- # practice that is only +**+ +^+; everything else in the supported
18
- # subset is byte-identical.
19
- #
20
- # @param expression [String] raw expression as the model wrote it
21
- # @return [String] expression with Python-style operators rewritten
22
- def self.normalize(expression)
23
- expression.gsub('**', '^')
24
- end
24
+ # Raised internally for anything {.calculate} should hand back to
25
+ # the model as an +"Error: ..."+ observation rather than crash
26
+ # the agent loop: parse failures, division by zero, complex or
27
+ # non-finite results. The message always names the offending
28
+ # token or operands.
29
+ class Error < StandardError; end
25
30
 
26
- # Evaluate +expression+ and return the result formatted as a String.
27
- # Parse, unbound-variable, and division-by-zero failures are caught
28
- # and returned as +"Error: ..."+ strings so the model can read the
29
- # failure as the next observation and self-correct rather than
30
- # crashing the agent loop.
31
+ # Evaluate +expression+ and return the result formatted as a
32
+ # String. Parse and arithmetic failures (division by zero,
33
+ # overflow to infinity, complex results) are caught and returned
34
+ # as +"Error: ..."+ strings so the model can read the failure as
35
+ # the next observation and self-correct rather than crashing the
36
+ # agent loop.
31
37
  #
32
- # @param expression [String]
38
+ # @param expression [String] Python-syntax arithmetic expression
33
39
  # @return [String] numeric result, or +"Error: ..."+ on failure
34
40
  def self.calculate(expression)
35
- result = Dentaku::Calculator.new.evaluate!(normalize(expression))
41
+ result = Parser.new(expression).parse
42
+ if result.is_a?(Float) && !result.finite?
43
+ raise Error, "result of #{expression.inspect} is not a finite number"
44
+ end
45
+
36
46
  format_result(result)
37
- rescue Dentaku::ZeroDivisionError, ZeroDivisionError
38
- 'Error: division by zero'
39
- rescue Dentaku::Error => e
47
+ rescue Error => e
40
48
  "Error: #{e.message}"
41
49
  end
42
50
 
43
- # Dentaku returns BigDecimal for any expression that touches division
44
- # or a decimal literal, with full BigDecimal precision (47-digit tails
45
- # for the leopard expression). Round to 3 places and strip the
46
- # default scientific-notation formatting so the model sees a short
47
- # readable number; integer/other results pass through unchanged.
51
+ # Integers (never produced by division +/+ is Python-3-style
52
+ # true division) pass through exact. Floats are rounded to 3
53
+ # places so the model sees a short readable number, and
54
+ # whole-valued floats drop the trailing +.0+ (+4 / 2+ renders as
55
+ # +"2"+, not +"2.0"+).
48
56
  def self.format_result(result)
49
- case result
50
- when BigDecimal then result.round(3).to_s('F')
51
- else result.to_s
52
- end
57
+ return result.to_s if result.is_a?(Integer)
58
+
59
+ rounded = result.round(3)
60
+ rounded == rounded.truncate ? rounded.truncate.to_s : rounded.to_s
53
61
  end
54
62
  private_class_method :format_result
63
+
64
+ # Recursive-descent parser-evaluator for Python's arithmetic
65
+ # expression grammar:
66
+ #
67
+ # additive := multiplicative (('+' | '-') multiplicative)*
68
+ # multiplicative := unary (('*' | '/' | '//' | '%') unary)*
69
+ # unary := ('+' | '-') unary | power
70
+ # power := atom ('**' unary)?
71
+ # atom := NUMBER | '(' additive ')'
72
+ #
73
+ # The +power+ → +unary+ recursion on the right operand is what
74
+ # makes +**+ right-associative (+2**3**2+ is 512) and lets a sign
75
+ # follow it (+2**-3+); +unary+ sitting *above* +power+ on the
76
+ # left is what makes +-2**2+ evaluate to -4 — both exactly as
77
+ # Python parses them.
78
+ #
79
+ # Semantics follow Python 3 where Ruby differs: +/+ is always
80
+ # true (float) division, +//+ floors, +2**-1+ is the Float 0.5
81
+ # (Ruby would return a Rational), and a negative base under a
82
+ # fractional exponent is rejected (Ruby would return a Complex).
83
+ class Parser
84
+ # One number or operator. +**+ / +//+ listed before their
85
+ # single-character prefixes so the two-character operators win;
86
+ # number literals cover +42+, +4.2+, +5.+, +.5+, and e-notation
87
+ # on any of them. +\G+ anchors each match at the scan position
88
+ # so nothing between tokens goes unnoticed.
89
+ TOKEN_RE = %r{\G\s*(\*\*|//|\d+(?:\.\d*)?(?:[eE][+-]?\d+)?|\.\d+(?:[eE][+-]?\d+)?|[-+*/%()])}
90
+
91
+ # @param expression [String] raw expression as the model wrote it
92
+ # @raise [Error] when +expression+ contains a character no token matches
93
+ def initialize(expression)
94
+ @tokens = tokenize(expression)
95
+ @pos = 0
96
+ end
97
+
98
+ # Parse and evaluate the whole token stream.
99
+ #
100
+ # @return [Integer, Float] the value of the expression
101
+ # @raise [Error] on syntax errors, division by zero, or a complex result
102
+ def parse
103
+ value = additive
104
+ raise Error, "unexpected #{peek.inspect} after expression" if peek
105
+
106
+ value
107
+ end
108
+
109
+ private
110
+
111
+ # @param expression [String]
112
+ # @return [Array<String>] token strings in source order
113
+ def tokenize(expression)
114
+ tokens = []
115
+ pos = 0
116
+ while (match = TOKEN_RE.match(expression, pos))
117
+ tokens << match[1]
118
+ pos = match.end(0)
119
+ end
120
+ rest = expression[pos..].to_s.strip
121
+ raise Error, "unexpected character #{rest[0].inspect} in #{expression.inspect}" unless rest.empty?
122
+
123
+ tokens
124
+ end
125
+
126
+ def additive
127
+ value = multiplicative
128
+ while (op = accept('+', '-'))
129
+ rhs = multiplicative
130
+ value = op == '+' ? value + rhs : value - rhs
131
+ end
132
+ value
133
+ end
134
+
135
+ def multiplicative
136
+ value = unary
137
+ while (op = accept('*', '/', '//', '%'))
138
+ value = apply_multiplicative(op, value, unary)
139
+ end
140
+ value
141
+ end
142
+
143
+ def unary
144
+ op = accept('+', '-')
145
+ return power unless op
146
+
147
+ value = unary
148
+ op == '-' ? -value : value
149
+ end
150
+
151
+ def power
152
+ base = atom
153
+ return base unless accept('**')
154
+
155
+ apply_power(base, unary)
156
+ end
157
+
158
+ def atom
159
+ return parenthesized if accept('(')
160
+
161
+ token = peek
162
+ unless token&.match?(/\A[.\d]/)
163
+ raise Error, token ? "unexpected #{token.inspect}" : 'unexpected end of expression'
164
+ end
165
+
166
+ @pos += 1
167
+ token.match?(/[.eE]/) ? token.to_f : token.to_i
168
+ end
169
+
170
+ def parenthesized
171
+ value = additive
172
+ raise Error, 'missing closing parenthesis' unless accept(')')
173
+
174
+ value
175
+ end
176
+
177
+ # @return [String, nil] the next token without consuming it
178
+ def peek
179
+ @tokens[@pos]
180
+ end
181
+
182
+ # Consume and return the next token if it is one of +expected+.
183
+ #
184
+ # @return [String, nil] the consumed token, or nil on no match
185
+ def accept(*expected)
186
+ token = peek
187
+ return nil unless expected.include?(token)
188
+
189
+ @pos += 1
190
+ token
191
+ end
192
+
193
+ # +/+ is Python-3 true division (always Float); +//+ floors
194
+ # (kept exact in Ruby's arbitrary-precision Integer division
195
+ # when both operands are Integers — Ruby's +Integer#/+ already
196
+ # floors like Python's +//+); +%+ delegates to Ruby's +%+,
197
+ # whose sign-of-divisor semantics match Python's exactly.
198
+ def apply_multiplicative(op, lhs, rhs)
199
+ return lhs * rhs if op == '*'
200
+ raise Error, 'division by zero' if rhs.zero?
201
+
202
+ case op
203
+ when '/' then lhs.fdiv(rhs)
204
+ when '//' then lhs.is_a?(Integer) && rhs.is_a?(Integer) ? lhs / rhs : lhs.fdiv(rhs).floor
205
+ when '%' then lhs % rhs
206
+ end
207
+ end
208
+
209
+ # Two Python-compatibility shims over Ruby's +**+: an Integer
210
+ # raised to a negative Integer yields a Float (Ruby would
211
+ # return a Rational), and a Complex result — negative base
212
+ # under a fractional exponent — is rejected loudly.
213
+ def apply_power(base, exponent)
214
+ if base.is_a?(Integer) && exponent.is_a?(Integer) && exponent.negative?
215
+ raise Error, 'division by zero' if base.zero?
216
+
217
+ return base.to_f**exponent
218
+ end
219
+ result = base**exponent
220
+ if result.is_a?(Complex)
221
+ raise Error, "(#{base})**(#{exponent}) is a complex number; only real arithmetic is supported"
222
+ end
223
+
224
+ result
225
+ end
226
+ end
55
227
  end
56
228
 
57
229
  # Arithmetic-evaluation tool backed by {Tool::Calculator.calculate}.
58
- # Accepts Python-flavored operator syntax (+, -, *, /, ** for
59
- # exponentiation, %, parentheses, decimals) so the model can emit the
60
- # syntax it already knows.
230
+ # Accepts Python expression syntax (+, -, *, /, //, %, ** for
231
+ # exponentiation, unary minus, parentheses, decimals) so the model
232
+ # can emit the syntax it already knows.
61
233
  #
62
234
  # @return [Tool]
63
235
  CALCULATOR = new(
@@ -67,7 +239,7 @@ module Pikuri
67
239
 
68
240
  Usage:
69
241
  - Use this for any arithmetic beyond simple mental math — do not eyeball multi-digit work.
70
- - Operators supported: +, -, *, /, ** (exponentiation), %, parentheses, decimal numbers.
242
+ - Python expression syntax: +, -, *, / (true division), // (floor division), % (modulo), ** (exponentiation), unary minus, parentheses, decimal numbers.
71
243
  - Decimal results are rounded to 3 places; integer results are exact.
72
244
  - Failures (parse error, division by zero) come back as "Error: ..." — read the message and re-call with a corrected expression.
73
245
  DESC
@@ -3,13 +3,14 @@
3
3
  module Pikuri
4
4
  class Tool
5
5
  # Truncation policy and Tool spec for the +fetch+ tool. The HTTP work
6
- # lives in {Tool::Scraper::Simple.fetch}; this module is a thin
6
+ # lives in {Tool::Scraper.fetch}; this module is a thin
7
7
  # wrapper that accepts only textual content-types, applies a character
8
8
  # cap so the LLM doesn't drown in long-form bodies, and exposes the
9
9
  # result to the agent loop in OpenAI tool-call shape.
10
10
  #
11
- # Sister of {Tool::WebScrape}, but without HTML→Markdown or PDF→text
12
- # extraction: bodies are returned verbatim. Useful for raw textual
11
+ # Sister of {Tool::WebScrape}, but with no extraction pass
12
+ # (HTML→Markdown, or whatever plug-in extractors are registered):
13
+ # bodies are returned verbatim. Useful for raw textual
13
14
  # data — JSON APIs, CSV files, +robots.txt+, sitemaps, source files —
14
15
  # where any rendering pass would corrupt the payload.
15
16
  module Fetch
@@ -56,7 +57,7 @@ module Pikuri
56
57
  CACHE
57
58
  end
58
59
 
59
- # Download +url+ via {Tool::Scraper::Simple.fetch} and return the
60
+ # Download +url+ via {Tool::Scraper.fetch} and return the
60
61
  # response body verbatim, provided the content-type is one we deem
61
62
  # textual (any +text/*+, plus the formats listed in
62
63
  # {TEXTUAL_APPLICATION_TYPES}). Anything else — PDFs, images, other
@@ -100,16 +101,16 @@ module Pikuri
100
101
  # redirect-loop exhaustion, missing +Location+ on a 3xx, or a
101
102
  # non-textual content-type
102
103
  def self.download(url)
103
- fetched = Scraper::Simple.fetch(url)
104
+ fetched = Scraper.fetch(url)
104
105
  return fetched.body if textual?(fetched.content_type)
105
106
 
106
107
  raise Scraper::FetchError,
107
108
  "refused to fetch #{url}: content-type #{fetched.content_type.inspect} " \
108
- 'is not textual (use web_scrape for PDFs or rendered pages)'
109
+ 'is not textual (use web_scrape for rendered pages)'
109
110
  end
110
111
 
111
112
  # @param content_type [String] normalized content-type (no +charset+
112
- # parameter, lowercased) as produced by {Scraper::Simple.fetch}
113
+ # parameter, lowercased) as produced by {Scraper.fetch}
113
114
  # @return [Boolean] true when the content-type is +text/*+ or one
114
115
  # of {TEXTUAL_APPLICATION_TYPES}
115
116
  def self.textual?(content_type)
@@ -138,7 +139,7 @@ module Pikuri
138
139
  # Verbatim URL download tool. Thin wrapper over {Tool::Fetch.fetch}
139
140
  # that exposes it to the agent loop in OpenAI tool-call shape. Use for
140
141
  # raw textual payloads (JSON APIs, CSV files, +robots.txt+, source
141
- # files); use {Tool::WEB_SCRAPE} for rendered web pages or PDFs where
142
+ # files); use {Tool::WEB_SCRAPE} for rendered web pages where
142
143
  # readability extraction makes the result usable.
143
144
  #
144
145
  # @return [Tool]
@@ -149,7 +150,7 @@ module Pikuri
149
150
 
150
151
  Usage:
151
152
  - Use for raw textual payloads: JSON APIs, CSV files, robots.txt, sitemaps, source files — anywhere a rendering pass would corrupt the data.
152
- - For rendered HTML pages or PDFs, use web_scrape — it extracts readable content; fetch returns the raw HTML/PDF bytes unchanged.
153
+ - For rendered HTML pages, use web_scrape — it extracts readable content; fetch returns the raw HTML bytes unchanged.
153
154
  - Accepts text/* and common textual application/* types (JSON, XML, JS, XHTML, RSS, Atom). Refuses PDFs, images, and other binaries.
154
155
  DESC
155
156
  parameters: Parameters.build { |p|