python-fire/fire/trace.py at master · google/python-fire · GitHub

History

306 lines (248 loc) · 10.1 KB

Raw

100

101

102

103

104

105

106

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

231

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

262

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

# Licensed under the Apache License, Version 2.0 (the "License");

# you may not use this file except in compliance with the License.

# You may obtain a copy of the License at

# http://www.apache.org/licenses/LICENSE-2.0

# Unless required by applicable law or agreed to in writing, software

# distributed under the License is distributed on an "AS IS" BASIS,

# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

# See the License for the specific language governing permissions and

# limitations under the License.

"""This module has classes for tracing the execution of a Fire execution.

A FireTrace consists of a sequence of FireTraceElement objects. Each element

represents an action taken by Fire during a single Fire execution. An action may

be instantiating a class, calling a routine, or accessing a property.

Each action consumes args and results in a new component. The final component

is serialized to stdout by Fire as well as returned by the Fire method. If

a Fire usage error occurs, such as insufficient arguments being provided to call

a function, then that error will be captured in the trace and the final

component will be None.

"""

import shlex

from fire import inspectutils

INITIAL_COMPONENT = 'Initial component'

INSTANTIATED_CLASS = 'Instantiated class'

CALLED_ROUTINE = 'Called routine'

CALLED_CALLABLE = 'Called callable'

ACCESSED_PROPERTY = 'Accessed property'

COMPLETION_SCRIPT = 'Generated completion script'

INTERACTIVE_MODE = 'Entered interactive mode'

class FireTrace:

"""A FireTrace represents the steps taken during a single Fire execution.

A FireTrace consists of a sequence of FireTraceElement objects. Each element

represents an action taken by Fire during a single Fire execution. An action

may be instantiating a class, calling a routine, or accessing a property.

"""

def __init__(self, initial_component, name=None, separator='-', verbose=False,

show_help=False, show_trace=False):

initial_trace_element = FireTraceElement(

component=initial_component,

action=INITIAL_COMPONENT,

)

self.name = name

self.separator = separator

self.elements = [initial_trace_element]

self.verbose = verbose

self.show_help = show_help

self.show_trace = show_trace

def GetResult(self):

"""Returns the component from the last element of the trace."""

return self.GetLastHealthyElement().component

def GetLastHealthyElement(self):

"""Returns the last element of the trace that is not an error.

This element will contain the final component indicated by the trace.

Returns:

The last element of the trace that is not an error.

"""

for element in reversed(self.elements):

if not element.HasError():

return element

return self.elements[0] # The initial element is always healthy.

def HasError(self):

"""Returns whether the Fire execution encountered a Fire usage error."""

return self.elements[-1].HasError()

def AddAccessedProperty(self, component, target, args, filename, lineno):

element = FireTraceElement(

component=component,

action=ACCESSED_PROPERTY,

target=target,

args=args,

filename=filename,

lineno=lineno,

)

self.elements.append(element)

def AddCalledComponent(self, component, target, args, filename, lineno,

capacity, action=CALLED_CALLABLE):

"""Adds an element to the trace indicating that a component was called.

Also applies to instantiating a class.

Args:

component: The result of calling the callable.

target: The name of the callable.

args: The args consumed in order to call this callable.

filename: The file in which the callable is defined, or None if N/A.

lineno: The line number on which the callable is defined, or None if N/A.

capacity: (bool) Whether the callable could have accepted additional args.

action: The value to include as the action in the FireTraceElement.

"""

element = FireTraceElement(

component=component,

action=action,

target=target,

args=args,

filename=filename,

lineno=lineno,

capacity=capacity,

)

self.elements.append(element)

def AddCompletionScript(self, script):

element = FireTraceElement(

component=script,

action=COMPLETION_SCRIPT,

)

self.elements.append(element)

def AddInteractiveMode(self):

element = FireTraceElement(action=INTERACTIVE_MODE)

self.elements.append(element)

def AddError(self, error, args):

element = FireTraceElement(error=error, args=args)

self.elements.append(element)

def AddSeparator(self):

"""Marks that the most recent element of the trace used a separator.

A separator is an argument you can pass to a Fire CLI to separate args left

of the separator from args right of the separator.

Here's an example to demonstrate the separator. Let's say you have a

function that takes a variable number of args, and you want to call that

function, and then upper case the result. Here's how to do it:

# in Python

def display(arg1, arg2='!'):

return arg1 + arg2

# from Bash (the default separator is the hyphen -)

display hello # hello!

display hello upper # helloupper

display hello - upper # HELLO!

Note how the separator caused the display function to be called with the

default value for arg2.

"""

self.elements[-1].AddSeparator()

def _Quote(self, arg):

if arg.startswith('--') and '=' in arg:

prefix, value = arg.split('=', 1)

return shlex.quote(prefix) + '=' + shlex.quote(value)

return shlex.quote(arg)

def GetCommand(self, include_separators=True):

"""Returns the command representing the trace up to this point.

Args:

include_separators: Whether or not to include separators in the command.

Returns:

A string representing a Fire CLI command that would produce this trace.

"""

args = []

if self.name:

args.append(self.name)

for element in self.elements:

if element.HasError():

continue

if element.args:

args.extend(element.args)

if element.HasSeparator() and include_separators:

args.append(self.separator)

if self.NeedsSeparator() and include_separators:

args.append(self.separator)

return ' '.join(self._Quote(arg) for arg in args)

def NeedsSeparator(self):

"""Returns whether a separator should be added to the command.

If the command is a function call, then adding an additional argument to the

command sometimes would add an extra arg to the function call, and sometimes

would add an arg acting on the result of the function call.

This function tells us whether we should add a separator to the command

before adding additional arguments in order to make sure the arg is applied

to the result of the function call, and not the function call itself.

Returns:

Whether a separator should be added to the command if order to keep the

component referred to by the command the same when adding additional args.

"""

element = self.GetLastHealthyElement()

return element.HasCapacity() and not element.HasSeparator()

def __str__(self):

lines = []

for index, element in enumerate(self.elements):

line = f'{index + 1}. {element}'

lines.append(line)

return '\n'.join(lines)

def NeedsSeparatingHyphenHyphen(self, flag='help'):

"""Returns whether a the trace need '--' before '--help'.

'--' is needed when the component takes keyword arguments, when the value of

flag matches one of the argument of the component, or the component takes in

keyword-only arguments(e.g. argument with default value).

Args:

flag: the flag available for the trace

Returns:

True for needed '--', False otherwise.

"""

element = self.GetLastHealthyElement()

component = element.component

spec = inspectutils.GetFullArgSpec(component)

return (spec.varkw is not None

or flag in spec.args

or flag in spec.kwonlyargs)

class FireTraceElement:

"""A FireTraceElement represents a single step taken by a Fire execution.

Examples of a FireTraceElement are the instantiation of a class or the

accessing of an object member.

"""

def __init__(self,

component=None,

action=None,

target=None,

args=None,

filename=None,

lineno=None,

error=None,

capacity=None):

"""Instantiates a FireTraceElement.

Args:

component: The result of this element of the trace.

action: The type of action (e.g. instantiating a class) taking place.

target: (string) The name of the component being acted upon.

args: The args consumed by the represented action.

filename: The file in which the action is defined, or None if N/A.

lineno: The line number on which the action is defined, or None if N/A.

error: The error represented by the action, or None if N/A.

capacity: (bool) Whether the action could have accepted additional args.

"""

self.component = component

self._action = action

self._target = target

self.args = args

self._filename = filename

self._lineno = lineno

self._error = error

self._separator = False

self._capacity = capacity

def HasError(self):

return self._error is not None

def HasCapacity(self):

return self._capacity

def HasSeparator(self):

return self._separator

def AddSeparator(self):

self._separator = True

def ErrorAsStr(self):

return ' '.join(str(arg) for arg in self._error.args)

def __str__(self):

if self.HasError():

return self.ErrorAsStr()

else:

# Format is: {action} "{target}" ({filename}:{lineno})

string = self._action

if self._target is not None:

string += f' "{self._target}"'

if self._filename is not None:

path = self._filename

if self._lineno is not None:

path += f':{self._lineno}'

string += f' ({path})'

return string

python-fire/fire/trace.py at master · google/python-fire · GitHub

Uh oh!

Expand file tree

Breadcrumbs

trace.py

Latest commit

History

Breadcrumbs

trace.py

File metadata and controls