Class: Squared::Workspace::Project::Python

Inherits:
Git
  • Object
show all
Defined in:
lib/squared/workspace/project/python.rb

Constant Summary

Constants included from Common

Common::ARG, Common::PATH

Instance Attribute Summary collapse

Attributes inherited from Base

#dependfile, #exception, #group, #name, #parent, #path, #pipe, #project, #theme, #verbose, #workspace

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Git

#branch, #checkout, #clean, #clone, #clone?, #commit, #diff, #enabled?, #fetch, #generate, #git, #logx, #ls_files, #ls_remote, #merge, #pull, #rebase, #reset, #restore, #rev_parse, #revbuild, #revbuild?, #show, #stash, #status, #tag

Methods inherited from Base

#add, aliasargs, #allref, #archive, #archive?, #as, as_path, #basepath, batchargs, #build, #build?, #clean, #clean?, #copy, #copy?, #dependtype, #dev?, #doc, #doc?, #enabled?, #error, #event, #exclude?, #first, #generate, #graph, #graph?, #has?, #initialize_build, #initialize_env, #initialize_events, #initialize_logger, #initialize_ref, #inject, #inspect, #last, #lint, #lint?, #localname, #log, #prod?, ref, #ref?, #rootpath, #script?, #series, subtasks, #task_include?, #test, #test?, to_s, #to_s, #to_sym, #unpack, #version, #with

Methods included from Common::Format

#enable_aixterm

Constructor Details

#initialize(venv: nil, editable: '.', verbose: nil, **kwargs) ⇒ Python

Returns a new instance of Python.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/squared/workspace/project/python.rb', line 74

def initialize(*, venv: nil, editable: '.', verbose: nil, **kwargs)
  super
  if @pass.include?(Python.ref)
    initialize_ref Python.ref
    initialize_logger(**kwargs)
  else
    initialize_build(Python.ref, **kwargs)
    initialize_env(**kwargs)
  end
  @dependindex = DEP_PYTHON.index { |file| basepath(file).exist? }
  @dependfile = basepath(DEP_PYTHON[@dependindex || 0])
  @verbose = $1.size if verbose.is_a?(String) && verbose =~ /^(v+)$/
  @editable = case editable
              when '.', Pathname
                editable
              when String
                Pathname.new(editable)
              end
  venv_set venv if venv
end

Instance Attribute Details

#editable ⇒ Object (readonly)

Returns the value of attribute editable.



72
73
74
 
# File 'lib/squared/workspace/project/python.rb', line 72

def editable
  @editable
end

#venv ⇒ Object (readonly)

Returns the value of attribute venv.



72
73
74
 
# File 'lib/squared/workspace/project/python.rb', line 72

def venv
  @venv
end

Class Method Details

.bannerargs ⇒ Object 



57
58
59
 
# File 'lib/squared/workspace/project/python.rb', line 57

def bannerargs
  [:dependfile].freeze
end

.config?(val) ⇒ Boolean

Returns:

  • (Boolean) 


65
66
67
68
69
 
# File 'lib/squared/workspace/project/python.rb', line 65

def config?(val)
  return false unless (val = as_path(val))

  DIR_PYTHON.any? { |file| val.join(file).exist? }
end

.populate ⇒ Object 



51
 
# File 'lib/squared/workspace/project/python.rb', line 51

def populate(*); end

.tasks ⇒ Object 



53
54
55
 
# File 'lib/squared/workspace/project/python.rb', line 53

def tasks
  [:outdated].freeze
end

.venv? ⇒ Boolean

Returns:

  • (Boolean) 


61
62
63
 
# File 'lib/squared/workspace/project/python.rb', line 61

def venv?
  Dir.exist?(ENV.fetch('VIRTUAL_ENV', ''))
end

Instance Method Details

#buildx(flag, opts = []) ⇒ Object 



351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/squared/workspace/project/python.rb', line 351

def buildx(flag, opts = [])
  out = []
  srcdir = nil
  case flag
  when :python
    cmd, opts = python_session('-m build', opts: opts)
    list = OPT_PYTHON[:build]
  when :poetry
    cmd = poetry_session 'build'
    list = OPT_POETRY[:build] + OPT_POETRY[:common]
  when :hatch
    cmd, opts = hatch_session('build', opts: opts)
    list = OPT_HATCH[:build]
  end
  option_sanitize(opts, list, single: flag == :python ? /^(?:v+|q+|b+)$/ : /^(?:v+|q+)$/).first.each do |opt|
    if !srcdir && basepath(opt).exist? && projectpath?(opt)
      srcdir = opt
    else
      out << opt
    end
  end
  case flag
  when :poetry
    if srcdir
      if session_arg?('o', 'output')
        out << srcdir
      else
        cmd << quote_option('output', basepath(srcdir))
      end
      srcdir = nil
    end
  when :hatch
    if ENV['HATCH_BUILD_LOCATION']
      srcdir = nil
    else
      srcdir ||= path
    end
    cmd << basic_option('p', project) unless ENV['HATCH_PROJECT'] || session_arg?('p', 'project')
  end
  cmd << shell_quote(basepath(srcdir)) if srcdir
  option_clear out
  run(from: :"#{flag}:build")
end

#depend(flag = nil, opts = [], sync: invoked_sync?('depend', flag), target: nil) ⇒ Object 



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/squared/workspace/project/python.rb', line 232

def depend(flag = nil, opts = [], sync: invoked_sync?('depend', flag), target: nil, **)
  if @depend && !flag
    super
  elsif outdated?
    venv_init
    workspace.rev_clear(name)
    if !flag && dependtype == 1
      cmd = poetry_session 'install', '-n'
      cmd << '--no-root' if option('no-root')
    else
      cmd = pip_session 'install'
      if flag
        case flag
        when :user
          cmd << '--user'
        when :target
          cmd << quote_option('target', basepath(target))
        when :force
          cmd << '--force-reinstall'
        end
        append_pip(flag, opts, from: :install)
      else
        append_global
      end
      cmd << "-r #{DEP_PYTHON[4]}" if basepath(DEP_PYTHON[4]).exist? && !session_arg?('r', 'requirement')
      append_editable
    end
    run(from: :depend, sync: sync)
  end
end

#depend? ⇒ Boolean

Returns:

  • (Boolean) 


451
452
453
 
# File 'lib/squared/workspace/project/python.rb', line 451

def depend?
  @depend != false && (!@depend.nil? || outdated?)
end

#install(flag, opts = [], strategy: nil) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/squared/workspace/project/python.rb', line 336

def install(flag, opts = [], strategy: nil)
  cmd = pip_session 'install'
  out = append_pip(flag, opts, from: :install)
  case flag
  when :editable
    cmd << quote_option('e', out.pop || editable || '.')
    option_clear out
  when :upgrade
    cmd << '--upgrade'
    cmd << basic_option('upgrade-strategy', strategy) if strategy
    append_value out
  end
  run(from: :install)
end

#outdated(sync: invoked_sync?('outdated')) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/squared/workspace/project/python.rb', line 263

def outdated(*, sync: invoked_sync?('outdated'))
  cmd = pip_session 'list', '--outdated'
  append_global
  cmd = session_done(cmd)
  log.info cmd
  on :first, :outdated
  banner = format_banner(cmd)
  print_item banner if sync
  start = 0
  found = 0
  major = 0
  pwd_set(from: :outdated) do
    buffer = []
    out = ->(val) { sync ? puts(val) : buffer << val }
    IO.popen(runenv || {}, cmd).each do |line|
      next if line.match?(/^[\s-]+$/)

      if start > 0
        unless stdin?
          data = line.scan(SEM_VER)
          next unless (cur = data.shift) && (lat = data.shift)

          latest = lat.join
          current = cur.join
          semver(cur)
          semver(lat)
          if semmajor?(cur, lat)
            type = 2
            major += 1
          else
            type = cur[2] == lat[2] ? 0 : 1
          end
          if type == 0
            styles = color(:yellow)
          else
            styles = color(:green)
            line = sub_style(line, pat: /^(\S+)(.+)$/, styles: if type == 2
                                                                 styles << :bold
                                                                 theme[:major]
                                                               else
                                                                 theme[:active]
                                                               end)
          end
          if theme[:current]
            line = sub_style(line, pat: /^(.+)(#{Regexp.escape(current)})(.+)$/, styles: theme[:current],
                                   index: 2)
          end
          line = sub_style(line, pat: /^(.+)(#{Regexp.escape(latest)})(.+)$/, styles: styles, index: 2)
          found += 1
        end
        out.("#{start.to_s.rjust(2)}. #{line}")
        start += 1
      elsif line.start_with?('Package')
        unless stdin?
          sub = { pat: /^(.*)(?<!\dm)(Package|Latest)(.+)$/, styles: theme[:header], index: 2 }
          out.(print_footer(" #  #{line.chomp}", reverse: true, sub: [sub, sub]))
        end
        start += 1
      end
    end
    unless sync
      print_item banner
      puts buffer
    end
    if found > 0
      puts print_footer empty_status('Updates are available', 'major', major)
    elsif start == 0
      puts 'No updates were found'
    end
  end
  on :last, :outdated
end

#outdated? ⇒ Boolean

Returns:

  • (Boolean) 


455
456
457
 
# File 'lib/squared/workspace/project/python.rb', line 455

def outdated?
  dependtype > 0
end

#pip(flag, opts = []) ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/squared/workspace/project/python.rb', line 417

def pip(flag, opts = [])
  cmd = pip_session flag
  out = append_pip(nil, opts, from: flag)
  case flag
  when :uninstall
    raise_error('no packages listed', subject: name, hint: 'uninstall') if out.empty?
    cmd.merge(out)
  when :freeze
    venv_init
    ret = basepath(out.shift || DEP_PYTHON[4])
    cmd << '>' << shell_quote(ret)
    option_clear out
  end
  run(from: :"pip:#{flag}")
  ret
end

#populate ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/squared/workspace/project/python.rb', line 107

def populate(*, **)
  super
  return unless outdated? && ref?(Python.ref)

  namespace name do
    @@tasks[Python.ref].each do |action, flags|
      next if @pass.include?(action)

      namespace action do
        flags.each do |flag|
          case action
          when 'venv'
            if flag == :create
              format_desc action, flag, 'dir,opts*'
              task flag, [:dir] do |_, args|
                dir = basepath(param_guard(action, flag, args: args, key: :dir))
                opts = python_session('-m venv', opts: args.extras).last
                opts = option_sanitize(opts, OPT_PYTHON[:venv]).first
                append_value(dir, delim: true)
                option_clear(opts, pass: false)
                run(exception: true)
                puts(dir.directory? ? "Success: #{dir}" : 'Failed')
              end
            elsif venv
              case flag
              when :remove
                next unless projectpath?(venv)

                format_desc action, flag, 'c|reate?,d|epend?'
                task flag do |_, args|
                  FileUtils.rm_rf(venv, verbose: true)
                  venv_init if has_value?(%w[c create], args.to_a)
                  depend if has_value?(%w[d depend], args.to_a)
                end
              when :run
                format_desc action, flag, 'args+'
                task flag do |_, args|
                  args = param_guard(action, flag, args: args.to_a)
                  venv_init
                  run session(*args, path: false)
                end
              when :show
                format_desc action, flag
                task flag do
                  puts venv
                end
              end
            end
          when 'pip'
            case flag
            when :freeze
              format_desc action, flag, "file?=#{DEP_PYTHON[4]},opts*"
              task flag do |_, args|
                if (file = pip(flag, args.to_a)) && verbose
                  puts File.read(file)
                end
              end
            when :uninstall
              format_desc action, flag, 'package+,opts*'
              task flag do |_, args|
                pip flag, args.to_a
              end
            end
          when 'install'
            format_desc(action, flag, 'opts*', before: case flag
                                                       when :target
                                                         'dir'
                                                       when :editable
                                                         'path/url?'
                                                       when :upgrade
                                                         'strategy?,package+'
                                                       end)
            case flag
            when :editable
              task flag do |_, args|
                install flag, args.to_a
              end
            when :upgrade
              task flag, [:strategy] do |_, args|
                case (strategy = args.strategy)
                when 'eager', 'only-if-needed'
                  opts = args.extras
                else
                  opts = args.to_a
                  strategy = nil
                end
                install(flag, opts, strategy: strategy)
              end
            when :target
              task flag, [:dir] do |_, args|
                dir = param_guard(action, flag, args: args, key: :dir)
                depend(flag, args.extras, target: dir)
              end
            else
              task flag do |_, args|
                depend flag, args.to_a
              end
            end
          when 'build'
            format_desc(action, flag, 'opts*', after: case flag
                                                      when :python
                                                        'srcdir?'
                                                      when :hatch
                                                        'location?'
                                                      end)
            task flag do |_, args|
              buildx flag, args.to_a
            end
          when 'publish'
            format_desc(action, flag, 'opts*', after: case flag
                                                      when :hatch
                                                        'artifacts?'
                                                      when :twine
                                                        'dist?'
                                                      end)
            task flag do |_, args|
              publish flag, args.to_a
            end
          end
        end
      end
    end
  end
end

#publish(flag, opts = []) ⇒ Object 



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/squared/workspace/project/python.rb', line 395

def publish(flag, opts = [])
  case flag
  when :poetry
    poetry_session 'publish'
    list = OPT_POETRY[:publish] + OPT_POETRY[:common]
  when :twine
    session 'twine', 'upload'
    list = OPT_TWINE[:publish]
  when :hatch
    opts = hatch_session('publish', opts: opts).last
    list = OPT_HATCH[:publish]
  end
  out = option_sanitize(opts, list, single: flag == :twine ? nil : /^(?:v+|q+)$/).first
  if out.empty?
    dist = basepath.join('dist')
    raise_error('no source files found', hint: dist) unless dist.directory? && !dist.empty?
    out << "#{dist}/*" unless flag == :poetry
  end
  append_value out
  run(from: :"#{flag}:publish")
end

#ref ⇒ Object 



103
104
105
 
# File 'lib/squared/workspace/project/python.rb', line 103

def ref
  Python.ref
end

#variable_set(key, *val) ⇒ Object 



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/squared/workspace/project/python.rb', line 434

def variable_set(key, *val, **)
  case key
  when :dependfile
    req = basepath(*val)
    if (index = DEP_PYTHON.index(req.basename.to_s))
      @dependindex = index
      @dependfile = req
    else
      log.warn "variable_set: @#{key}=#{req} (not supported)"
    end
  when :venv, :editable
    instance_variable_set(:"@#{key}", val.empty? ? nil : basepath(*val))
  else
    super
  end
end