~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/commands.py

• browse files at revision 5896
• compare with another revision
• compare with revision 3815
• download diff
• download tarball
• view history from revision 5896

Show diffs side-by-side

added

removed

bzrlib/commands.py

357

357

    summary, then a complete description of the command.  A grammar

358

358

    description will be inserted.

359

359

 

360

 

    aliases

361

 

        Other accepted names for this command.

362

 

 

363

 

    takes_args

364

 

        List of argument forms, marked with whether they are optional,

365

 

        repeated, etc.

366

 

 

367

 

                Examples:

368

 

 

369

 

                ['to_location', 'from_branch?', 'file*']

370

 

 

371

 

                'to_location' is required

372

 

                'from_branch' is optional

373

 

                'file' can be specified 0 or more times

374

 

 

375

 

    takes_options

376

 

        List of options that may be given for this command.  These can

377

 

        be either strings, referring to globally-defined options,

378

 

        or option objects.  Retrieve through options().

379

 

 

380

 

    hidden

381

 

        If true, this command isn't advertised.  This is typically

 

360

    :cvar aliases: Other accepted names for this command.

 

361

 

 

362

    :cvar takes_args: List of argument forms, marked with whether they are

 

363

        optional, repeated, etc.  Examples::

 

364

 

 

365

            ['to_location', 'from_branch?', 'file*']

 

366

 

 

367

        * 'to_location' is required

 

368

        * 'from_branch' is optional

 

369

        * 'file' can be specified 0 or more times

 

370

 

 

371

    :cvar takes_options: List of options that may be given for this command.

 

372

        These can be either strings, referring to globally-defined options, or

 

373

        option objects.  Retrieve through options().

 

374

 

 

375

    :cvar hidden: If true, this command isn't advertised.  This is typically

382

376

        for commands intended for expert users.

383

377

 

384

 

    encoding_type

385

 

        Command objects will get a 'outf' attribute, which has been

386

 

        setup to properly handle encoding of unicode strings.

387

 

        encoding_type determines what will happen when characters cannot

388

 

        be encoded

389

 

            strict - abort if we cannot decode

390

 

            replace - put in a bogus character (typically '?')

391

 

            exact - do not encode sys.stdout

392

 

 

393

 

            NOTE: by default on Windows, sys.stdout is opened as a text

394

 

            stream, therefore LF line-endings are converted to CRLF.

395

 

            When a command uses encoding_type = 'exact', then

396

 

            sys.stdout is forced to be a binary stream, and line-endings

397

 

            will not mangled.

398

 

 

399

 

    :ivar invoked_as:

 

378

    :cvar encoding_type: Command objects will get a 'outf' attribute, which has

 

379

        been setup to properly handle encoding of unicode strings.

 

380

        encoding_type determines what will happen when characters cannot be

 

381

        encoded:

 

382

 

 

383

        * strict - abort if we cannot decode

 

384

        * replace - put in a bogus character (typically '?')

 

385

        * exact - do not encode sys.stdout

 

386

 

 

387

        NOTE: by default on Windows, sys.stdout is opened as a text stream,

 

388

        therefore LF line-endings are converted to CRLF.  When a command uses

 

389

        encoding_type = 'exact', then sys.stdout is forced to be a binary

 

390

        stream, and line-endings will not mangled.

 

391

 

 

392

    :cvar invoked_as:

400

393

        A string indicating the real name under which this command was

401

 

        invoked, before expansion of aliases. 

 

394

        invoked, before expansion of aliases.

402

395

        (This may be None if the command was constructed and run in-process.)

403

396

 

404

397

    :cvar hooks: An instance of CommandHooks.

405

398

 

406

 

    :ivar __doc__: The help shown by 'bzr help command' for this command.

 

399

    :cvar __doc__: The help shown by 'bzr help command' for this command.

407

400

        This is set by assigning explicitly to __doc__ so that -OO can

408

401

        be used::

409

402

 

410

 

        class Foo(Command):

411

 

            __doc__ = "My help goes here"

 

403

            class Foo(Command):

 

404

                __doc__ = "My help goes here"

412

405

    """

413

406

    aliases = []

414

407

    takes_args = []

1275

1268

 

1276

1269

 

1277

1270

class Provider(object):

1278

 

    '''Generic class to be overriden by plugins'''

 

1271

    """Generic class to be overriden by plugins"""

1279

1272

 

1280

1273

    def plugin_for_command(self, cmd_name):

1281

 

        '''Takes a command and returns the information for that plugin

 

1274

        """Takes a command and returns the information for that plugin

1282

1275

 

1283

1276

        :return: A dictionary with all the available information

1284

 

        for the requested plugin

1285

 

        '''

 

1277

            for the requested plugin

 

1278

        """

1286

1279

        raise NotImplementedError

1287

1280

 

1288

1281

 

1289

1282

class ProvidersRegistry(registry.Registry):

1290

 

    '''This registry exists to allow other providers to exist'''

 

1283

    """This registry exists to allow other providers to exist"""

1291

1284

 

1292

1285

    def __iter__(self):

1293

1286

        for key, provider in self.iteritems():

• Older »

Loggerhead is a web-based interface for Breezy
Version: 2.0.1