python-docs-fa/c-api/unicode.html at gh-pages · python/python-docs-fa

History

2408 lines (2214 loc) · 315 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

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

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

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

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

<!DOCTYPE html>

<head>

<title>Unicode Objects and Codecs — مستندات Python3.14.6</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

title="جستجو در مستندات Python3.14.6"

href="../_static/opensearch.xml"/>

<style>

@media only screen {

table.full-width-table {

width: 100%;

}

</style>

</head>

<body>

<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">

</label>

</a>

</svg>

</form>

</nav>

Theme

<option value="light">Light</option>

</select>

</label>

<div>

<h3><a href="../contents.html">فهرست عناوین</a></h3>

<ul>

<li><a class="reference internal" href="#">Unicode Objects and Codecs</a><ul>

<li><a class="reference internal" href="#unicode-objects">Unicode Objects</a><ul>

<li><a class="reference internal" href="#unicode-type">Unicode Type</a></li>

<li><a class="reference internal" href="#unicode-character-properties">Unicode Character Properties</a></li>

<li><a class="reference internal" href="#creating-and-accessing-unicode-strings">Creating and accessing Unicode strings</a></li>

<li><a class="reference internal" href="#locale-encoding">Locale Encoding</a></li>

<li><a class="reference internal" href="#file-system-encoding">File System Encoding</a></li>

<li><a class="reference internal" href="#wchar-t-support">wchar_t Support</a></li>

</ul>

</li>

<li><a class="reference internal" href="#built-in-codecs">Built-in Codecs</a><ul>

<li><a class="reference internal" href="#generic-codecs">Generic Codecs</a></li>

<li><a class="reference internal" href="#utf-8-codecs">UTF-8 Codecs</a></li>

<li><a class="reference internal" href="#utf-32-codecs">UTF-32 Codecs</a></li>

<li><a class="reference internal" href="#utf-16-codecs">UTF-16 Codecs</a></li>

<li><a class="reference internal" href="#utf-7-codecs">UTF-7 Codecs</a></li>

<li><a class="reference internal" href="#unicode-escape-codecs">Unicode-Escape Codecs</a></li>

<li><a class="reference internal" href="#raw-unicode-escape-codecs">Raw-Unicode-Escape Codecs</a></li>

<li><a class="reference internal" href="#latin-1-codecs">Latin-1 Codecs</a></li>

<li><a class="reference internal" href="#ascii-codecs">ASCII Codecs</a></li>

<li><a class="reference internal" href="#character-map-codecs">Character Map Codecs</a></li>

<li><a class="reference internal" href="#mbcs-codecs-for-windows">MBCS codecs for Windows</a></li>

</ul>

</li>

<li><a class="reference internal" href="#methods-and-slot-functions">Methods and Slot Functions</a></li>

<li><a class="reference internal" href="#pyunicodewriter">PyUnicodeWriter</a></li>

<li><a class="reference internal" href="#deprecated-api">Deprecated API</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>موضوع قبلی</h4>

<a href="bytearray.html"

title="فصل قبلی">اشیاء آرایه‌ی بایت</a>

</div>

<div>

<h4>موضوع بعدی</h4>

<a href="tuple.html"

title="فصل بعدی">Tuple Objects</a>

</div>

document.addEventListener('DOMContentLoaded', () => {

const title = document.querySelector('meta[property="og:title"]').content;

const elements = document.querySelectorAll('.improvepage');

const pageurl = window.location.href.split('?')[0];

elements.forEach(element => {

const url = new URL(element.href.split('?')[0].replace("-nojs", ""));

url.searchParams.set('pagetitle', title);

url.searchParams.set('pageurl', pageurl);

url.searchParams.set('pagesource', "c-api/unicode.rst");

element.href = url.toString();

});

</script>

<li><a href="../bugs.html">گزارش یک اشکال</a></li>

<li><a class="improvepage" href="../improve-page-nojs.html">بهبود این صفحه</a></li>

<li>

<a href="https://github.com/python/cpython/blob/main/Doc/c-api/unicode.rst?plain=1"

rel="nofollow">نمایش منبع

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/c-api/unicode.po?plain=1"

rel="nofollow">نمایش منبع ترجمه</a>

</li>

</ul>

</div>

</nav>

</div>

<h3>ناوبری</h3>

<ul>

<a href="../genindex.html" title="فهرست کلی"

accesskey="I">فهرست</a></li>

<a href="../py-modindex.html" title="نمایه ی ماژول های پایتون"

>ماژول ها</a> |</li>

<a href="tuple.html" title="Tuple Objects"

accesskey="N">بعدی</a> |</li>

<a href="bytearray.html" title="اشیاء آرایه‌ی بایت"

accesskey="P">قبلی</a> |</li>

<li><a href="https://www.python.org/">Python</a> »</li>

</li>

<li>

</li>

<a href="../index.html">3.14.6 Documentation</a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API reference manual</a> »</li>

<li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li>

<li class="nav-item nav-item-this"><a href="">Unicode Objects and Codecs</a></li>

</form>

</div>

</li>

Theme

<option value="light">Light</option>

</select>

</label> |</li>

</ul>

</div>

<h1>Unicode Objects and Codecs<a class="headerlink" href="#unicode-objects-and-codecs" title="Link to this heading">¶</a></h1>

<h2>Unicode Objects<a class="headerlink" href="#unicode-objects" title="Link to this heading">¶</a></h2>

Since the implementation of <a class="pep reference external" href="https://peps.python.org/pep-0393/">PEP 393</a> in Python 3.3, Unicode objects internally

use a variety of representations, in order to allow handling the complete range

of Unicode characters while staying memory efficient. There are special cases

for strings where all code points are below 128, 256, or 65536; otherwise, code

points must be below 1114112 (which is the full Unicode range).

UTF-8 representation is created on demand and cached in the Unicode object.

توجه

The <a class="reference internal" href="#c.Py_UNICODE" title="Py_UNICODE"><code class="xref c c-type docutils literal notranslate">Py_UNICODE</code></a> representation has been removed since Python 3.12

with deprecated APIs.

See <a class="pep reference external" href="https://peps.python.org/pep-0623/">PEP 623</a> for more information.

</div>

<h3>Unicode Type<a class="headerlink" href="#unicode-type" title="Link to this heading">¶</a></h3>

These are the basic Unicode object types used for the Unicode implementation in

Python:

<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyUnicode_Type<a class="headerlink" href="#c.PyUnicode_Type" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.This instance of <a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a> represents the Python Unicode type.

It is exposed to Python code as <a class="reference internal" href="../library/stdtypes.html#str" title="str"><code class="xref py py-class docutils literal notranslate">str</code></a>.

</dd></dl>

<a class="reference internal" href="type.html#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyUnicodeIter_Type<a class="headerlink" href="#c.PyUnicodeIter_Type" title="Link to this definition">¶</a> </dt>

iterator type. It is used to iterate over Unicode string objects.

</dd></dl>

type Py_UCS4<a class="headerlink" href="#c.Py_UCS4" title="Link to this definition">¶</a> </dt>

type Py_UCS2<a class="headerlink" href="#c.Py_UCS2" title="Link to this definition">¶</a> </dt>

type Py_UCS1<a class="headerlink" href="#c.Py_UCS1" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.These types are typedefs for unsigned integer types wide enough to contain

characters of 32 bits, 16 bits and 8 bits, respectively. When dealing with

single Unicode characters, use <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4"><code class="xref c c-type docutils literal notranslate">Py_UCS4</code></a>.

Added in version 3.3.

</div>

</dd></dl>

type PyASCIIObject<a class="headerlink" href="#c.PyASCIIObject" title="Link to this definition">¶</a> </dt>

type PyCompactUnicodeObject<a class="headerlink" href="#c.PyCompactUnicodeObject" title="Link to this definition">¶</a> </dt>

type PyUnicodeObject<a class="headerlink" href="#c.PyUnicodeObject" title="Link to this definition">¶</a> </dt>

<dd>These subtypes of <a class="reference internal" href="structures.html#c.PyObject" title="PyObject"><code class="xref c c-type docutils literal notranslate">PyObject</code></a> represent a Python Unicode object. In

almost all cases, they shouldn't be used directly, since all API functions

that deal with Unicode objects take and return <code class="xref c c-type docutils literal notranslate">PyObject</code> pointers.

Added in version 3.3.

</div>

The structure of a particular object can be determined using the following

macros.

The macros cannot fail; their behavior is undefined if their argument

is not a Python Unicode object.

PyUnicode_IS_COMPACT(o)<a class="headerlink" href="#c.PyUnicode_IS_COMPACT" title="Link to this definition">¶</a> </dt>

<dd>True if o uses the <a class="reference internal" href="#c.PyCompactUnicodeObject" title="PyCompactUnicodeObject"><code class="xref c c-struct docutils literal notranslate">PyCompactUnicodeObject</code></a> structure.

Added in version 3.3.

</div>

</dd></dl>

PyUnicode_IS_COMPACT_ASCII(o)<a class="headerlink" href="#c.PyUnicode_IS_COMPACT_ASCII" title="Link to this definition">¶</a> </dt>

<dd>True if o uses the <a class="reference internal" href="#c.PyASCIIObject" title="PyASCIIObject"><code class="xref c c-struct docutils literal notranslate">PyASCIIObject</code></a> structure.

Added in version 3.3.

</div>

</dd></dl>

The following APIs are C macros and static inlined functions for fast checks and

access to internal read-only data of Unicode objects:

int PyUnicode_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj)<a class="headerlink" href="#c.PyUnicode_Check" title="Link to this definition">¶</a> </dt>

<dd>Return true if the object obj is a Unicode object or an instance of a Unicode

subtype. This function always succeeds.

</dd></dl>

int PyUnicode_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *obj)<a class="headerlink" href="#c.PyUnicode_CheckExact" title="Link to this definition">¶</a> </dt>

<dd>Return true if the object obj is a Unicode object, but not an instance of a

subtype. This function always succeeds.

</dd></dl>

<a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> PyUnicode_GET_LENGTH(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_GET_LENGTH" title="Link to this definition">¶</a> </dt>

<dd>Return the length of the Unicode string, in code points. unicode has to be a

Unicode object in the "canonical" representation (not checked).

Added in version 3.3.

</div>

</dd></dl>

<a class="reference internal" href="#c.Py_UCS1" title="Py_UCS1">Py_UCS1</a> *PyUnicode_1BYTE_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_1BYTE_DATA" title="Link to this definition">¶</a> </dt>

<a class="reference internal" href="#c.Py_UCS2" title="Py_UCS2">Py_UCS2</a> *PyUnicode_2BYTE_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_2BYTE_DATA" title="Link to this definition">¶</a> </dt>

<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> *PyUnicode_4BYTE_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_4BYTE_DATA" title="Link to this definition">¶</a> </dt>

<dd>Return a pointer to the canonical representation cast to UCS1, UCS2 or UCS4

integer types for direct character access. No checks are performed if the

canonical representation has the correct character size; use

<a class="reference internal" href="#c.PyUnicode_KIND" title="PyUnicode_KIND"><code class="xref c c-func docutils literal notranslate">PyUnicode_KIND()</code></a> to select the right function.

Added in version 3.3.

</div>

</dd></dl>

PyUnicode_1BYTE_KIND<a class="headerlink" href="#c.PyUnicode_1BYTE_KIND" title="Link to this definition">¶</a> </dt>

PyUnicode_2BYTE_KIND<a class="headerlink" href="#c.PyUnicode_2BYTE_KIND" title="Link to this definition">¶</a> </dt>

PyUnicode_4BYTE_KIND<a class="headerlink" href="#c.PyUnicode_4BYTE_KIND" title="Link to this definition">¶</a> </dt>

<dd>Return values of the <a class="reference internal" href="#c.PyUnicode_KIND" title="PyUnicode_KIND"><code class="xref c c-func docutils literal notranslate">PyUnicode_KIND()</code></a> macro.

Added in version 3.3.

</div>

تغییر داده شده در نسخه 3.12: <code class="docutils literal notranslate">PyUnicode_WCHAR_KIND</code> has been removed.

</div>

</dd></dl>

int PyUnicode_KIND(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_KIND" title="Link to this definition">¶</a> </dt>

<dd>Return one of the PyUnicode kind constants (see above) that indicate how many

bytes per character this Unicode object uses to store its data. unicode has to

be a Unicode object in the "canonical" representation (not checked).

Added in version 3.3.

</div>

</dd></dl>

void *PyUnicode_DATA(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_DATA" title="Link to this definition">¶</a> </dt>

<dd>Return a void pointer to the raw Unicode buffer. unicode has to be a Unicode

object in the "canonical" representation (not checked).

Added in version 3.3.

</div>

</dd></dl>

void PyUnicode_WRITE(int kind, void *data, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> value)<a class="headerlink" href="#c.PyUnicode_WRITE" title="Link to this definition">¶</a> </dt>

<dd>Write the code point value to the given zero-based index in a string.

The kind value and data pointer must have been obtained from a

string using <a class="reference internal" href="#c.PyUnicode_KIND" title="PyUnicode_KIND"><code class="xref c c-func docutils literal notranslate">PyUnicode_KIND()</code></a> and <a class="reference internal" href="#c.PyUnicode_DATA" title="PyUnicode_DATA"><code class="xref c c-func docutils literal notranslate">PyUnicode_DATA()</code></a>

respectively. You must hold a reference to that string while calling

<code class="xref c c-func docutils literal notranslate">PyUnicode_WRITE()</code>. All requirements of

<a class="reference internal" href="#c.PyUnicode_WriteChar" title="PyUnicode_WriteChar"><code class="xref c c-func docutils literal notranslate">PyUnicode_WriteChar()</code></a> also apply.

The function performs no checks for any of its requirements,

and is intended for usage in loops.

Added in version 3.3.

</div>

</dd></dl>

<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> PyUnicode_READ(int kind, void *data, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index)<a class="headerlink" href="#c.PyUnicode_READ" title="Link to this definition">¶</a> </dt>

<dd>Read a code point from a canonical representation data (as obtained with

<a class="reference internal" href="#c.PyUnicode_DATA" title="PyUnicode_DATA"><code class="xref c c-func docutils literal notranslate">PyUnicode_DATA()</code></a>). No checks or ready calls are performed.

Added in version 3.3.

</div>

</dd></dl>

<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> PyUnicode_READ_CHAR(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> index)<a class="headerlink" href="#c.PyUnicode_READ_CHAR" title="Link to this definition">¶</a> </dt>

<dd>Read a character from a Unicode object unicode, which must be in the "canonical"

representation. This is less efficient than <a class="reference internal" href="#c.PyUnicode_READ" title="PyUnicode_READ"><code class="xref c c-func docutils literal notranslate">PyUnicode_READ()</code></a> if you

do multiple consecutive reads.

Added in version 3.3.

</div>

</dd></dl>

<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> PyUnicode_MAX_CHAR_VALUE(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_MAX_CHAR_VALUE" title="Link to this definition">¶</a> </dt>

<dd>Return the maximum code point that is suitable for creating another string

based on unicode, which must be in the "canonical" representation. This is

always an approximation but more efficient than iterating over the string.

Added in version 3.3.

</div>

</dd></dl>

int PyUnicode_IsIdentifier(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_IsIdentifier" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return <code class="docutils literal notranslate">1</code> if the string is a valid identifier according to the language

definition, section <a class="reference internal" href="../reference/lexical_analysis.html#identifiers">Names (identifiers and keywords)</a>. Return <code class="docutils literal notranslate">0</code> otherwise.

تغییر داده شده در نسخه 3.9: The function does not call <a class="reference internal" href="sys.html#c.Py_FatalError" title="Py_FatalError"><code class="xref c c-func docutils literal notranslate">Py_FatalError()</code></a> anymore if the string

is not ready.

</div>

</dd></dl>

unsigned int PyUnicode_IS_ASCII(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *unicode)<a class="headerlink" href="#c.PyUnicode_IS_ASCII" title="Link to this definition">¶</a> </dt>

<dd>Return true if the string only contains ASCII characters.

Equivalent to <a class="reference internal" href="../library/stdtypes.html#str.isascii" title="str.isascii"><code class="xref py py-meth docutils literal notranslate">str.isascii()</code></a>.

Added in version 3.2.

</div>

</dd></dl>

</section>

<h3>Unicode Character Properties<a class="headerlink" href="#unicode-character-properties" title="Link to this heading">¶</a></h3>

Unicode provides many different character properties. The most often needed ones

are available through these macros which are mapped to C functions depending on

the Python configuration.

int Py_UNICODE_ISSPACE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISSPACE" title="Link to this definition">¶</a> </dt>

<dd>Return <code class="docutils literal notranslate">1</code> or <code class="docutils literal notranslate">0</code> depending on whether ch is a whitespace character.

</dd></dl>

int Py_UNICODE_ISLOWER(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISLOWER" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISUPPER(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISUPPER" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISTITLE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISTITLE" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISLINEBREAK(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISLINEBREAK" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISDECIMAL(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISDECIMAL" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISDIGIT(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISDIGIT" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISNUMERIC(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISNUMERIC" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISALPHA(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISALPHA" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISALNUM(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISALNUM" title="Link to this definition">¶</a> </dt>

</dd></dl>

int Py_UNICODE_ISPRINTABLE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_ISPRINTABLE" title="Link to this definition">¶</a> </dt>

in the sense of <a class="reference internal" href="../library/stdtypes.html#str.isprintable" title="str.isprintable"><code class="xref py py-meth docutils literal notranslate">str.isprintable()</code></a>.

</dd></dl>

These APIs can be used for fast direct character conversions:

<dd>Return the character ch converted to lower case.

</dd></dl>

<dd>Return the character ch converted to upper case.

</dd></dl>

<dd>Return the character ch converted to title case.

</dd></dl>

int Py_UNICODE_TODECIMAL(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TODECIMAL" title="Link to this definition">¶</a> </dt>

<dd>Return the character ch converted to a decimal positive integer. Return

<code class="docutils literal notranslate">-1</code> if this is not possible. This function does not raise exceptions.

</dd></dl>

int Py_UNICODE_TODIGIT(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TODIGIT" title="Link to this definition">¶</a> </dt>

<dd>Return the character ch converted to a single digit integer. Return <code class="docutils literal notranslate">-1</code> if

this is not possible. This function does not raise exceptions.

</dd></dl>

double Py_UNICODE_TONUMERIC(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_TONUMERIC" title="Link to this definition">¶</a> </dt>

<dd>Return the character ch converted to a double. Return <code class="docutils literal notranslate">-1.0</code> if this is not

possible. This function does not raise exceptions.

</dd></dl>

These APIs can be used to work with surrogates:

int Py_UNICODE_IS_SURROGATE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_IS_SURROGATE" title="Link to this definition">¶</a> </dt>

<dd>Check if ch is a surrogate (<code class="docutils literal notranslate">0xD800 <= ch <= 0xDFFF</code>).

</dd></dl>

int Py_UNICODE_IS_HIGH_SURROGATE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_IS_HIGH_SURROGATE" title="Link to this definition">¶</a> </dt>

<dd>Check if ch is a high surrogate (<code class="docutils literal notranslate">0xD800 <= ch <= 0xDBFF</code>).

</dd></dl>

int Py_UNICODE_IS_LOW_SURROGATE(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> ch)<a class="headerlink" href="#c.Py_UNICODE_IS_LOW_SURROGATE" title="Link to this definition">¶</a> </dt>

<dd>Check if ch is a low surrogate (<code class="docutils literal notranslate">0xDC00 <= ch <= 0xDFFF</code>).

</dd></dl>

<dd>Return the high UTF-16 surrogate (<code class="docutils literal notranslate">0xD800</code> to <code class="docutils literal notranslate">0xDBFF</code>) for a Unicode

code point in the range <code class="docutils literal notranslate">[0x10000; 0x10FFFF]</code>.

</dd></dl>

<dd>Return the low UTF-16 surrogate (<code class="docutils literal notranslate">0xDC00</code> to <code class="docutils literal notranslate">0xDFFF</code>) for a Unicode

code point in the range <code class="docutils literal notranslate">[0x10000; 0x10FFFF]</code>.

</dd></dl>

<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> Py_UNICODE_JOIN_SURROGATES(<a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> high, <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4">Py_UCS4</a> low)<a class="headerlink" href="#c.Py_UNICODE_JOIN_SURROGATES" title="Link to this definition">¶</a> </dt>

<dd>Join two surrogate code points and return a single <a class="reference internal" href="#c.Py_UCS4" title="Py_UCS4"><code class="xref c c-type docutils literal notranslate">Py_UCS4</code></a> value.

high and low are respectively the leading and trailing surrogates in a

surrogate pair. high must be in the range <code class="docutils literal notranslate">[0xD800; 0xDBFF]</code> and low must

be in the range <code class="docutils literal notranslate">[0xDC00; 0xDFFF]</code>.

</dd></dl>

</section>

<h3>Creating and accessing Unicode strings<a class="headerlink" href="#creating-and-accessing-unicode-strings" title="Link to this heading">¶</a></h3>

To create Unicode objects and access their basic sequence properties, use these

APIs:

<dd>مقدار بازگشتی: مرجع جدید.Create a new Unicode object. maxchar should be the true maximum code point

to be placed in the string. As an approximation, it can be rounded up to the

nearest value in the sequence 127, 255, 65535, 1114111.

On error, set an exception and return <code class="docutils literal notranslate">NULL</code>.

After creation, the string can be filled by <a class="reference internal" href="#c.PyUnicode_WriteChar" title="PyUnicode_WriteChar"><code class="xref c c-func docutils literal notranslate">PyUnicode_WriteChar()</code></a>,

<a class="reference internal" href="#c.PyUnicode_CopyCharacters" title="PyUnicode_CopyCharacters"><code class="xref c c-func docutils literal notranslate">PyUnicode_CopyCharacters()</code></a>, <a class="reference internal" href="#c.PyUnicode_Fill" title="PyUnicode_Fill"><code class="xref c c-func docutils literal notranslate">PyUnicode_Fill()</code></a>,

<a class="reference internal" href="#c.PyUnicode_WRITE" title="PyUnicode_WRITE"><code class="xref c c-func docutils literal notranslate">PyUnicode_WRITE()</code></a> or similar.

Since strings are supposed to be immutable, take care to not “use” the

result while it is being modified. In particular, before it's filled

with its final contents, a string:

<li>must not be hashed,</li>

<li>must not be <a class="reference internal" href="#c.PyUnicode_AsUTF8AndSize" title="PyUnicode_AsUTF8AndSize"><code class="xref c c-func docutils literal notranslate">converted to UTF-8</code></a>,

or another non-"canonical" representation,</li>

<li>must not have its reference count changed,</li>

<li>must not be shared with code that might do one of the above.</li>

</ul>

This list is not exhaustive. Avoiding these uses is your responsibility;

Python does not always check these requirements.

To avoid accidentally exposing a partially-written string object, prefer

using the <a class="reference internal" href="#c.PyUnicodeWriter" title="PyUnicodeWriter"><code class="xref c c-type docutils literal notranslate">PyUnicodeWriter</code></a> API, or one of the <code class="docutils literal notranslate">PyUnicode_From*</code>

functions below.

Added in version 3.3.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromKindAndData(int kind, const void *buffer, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_FromKindAndData" title="Link to this definition">¶</a> </dt>

<dd>مقدار بازگشتی: مرجع جدید.Create a new Unicode object with the given kind (possible values are

<a class="reference internal" href="#c.PyUnicode_1BYTE_KIND" title="PyUnicode_1BYTE_KIND"><code class="xref c c-macro docutils literal notranslate">PyUnicode_1BYTE_KIND</code></a> etc., as returned by

units of 1, 2 or 4 bytes per character, as given by the kind.

If necessary, the input buffer is copied and transformed into the

canonical representation. For example, if the buffer is a UCS4 string

(<a class="reference internal" href="#c.PyUnicode_4BYTE_KIND" title="PyUnicode_4BYTE_KIND"><code class="xref c c-macro docutils literal notranslate">PyUnicode_4BYTE_KIND</code></a>) and it consists only of codepoints in

the UCS1 range, it will be transformed into UCS1

(<a class="reference internal" href="#c.PyUnicode_1BYTE_KIND" title="PyUnicode_1BYTE_KIND"><code class="xref c c-macro docutils literal notranslate">PyUnicode_1BYTE_KIND</code></a>).

Added in version 3.3.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyUnicode_FromStringAndSize(const char *str, <a class="reference internal" href="intro.html#c.Py_ssize_t" title="Py_ssize_t">Py_ssize_t</a> size)<a class="headerlink" href="#c.PyUnicode_FromStringAndSize" title="Link to this definition">¶</a> </dt>

interpreted as being UTF-8 encoded. The buffer is copied into the new

object.

The return value might be a shared object, i.e. modification of the data is

not allowed.

This function raises <a class="reference internal" href="../library/exceptions.html#SystemError" title="SystemError"><code class="xref py py-exc docutils literal notranslate">SystemError</code></a> when:

</ul>

تغییر داده شده در نسخه 3.12: str == <code class="docutils literal notranslate">NULL</code> with size > 0 is not allowed anymore.

</div>

</dd></dl>

str.

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Take a C <code class="xref c c-func docutils literal notranslate">printf()</code>-style format string and a variable number of

arguments, calculate the size of the resulting Python Unicode string and return

a string with the values formatted into it. The variable arguments must be C

types and must correspond exactly to the format characters in the format

ASCII-encoded string.

A conversion specifier contains two or more characters and has the following

components, which must occur in this order:

<li>The <code class="docutils literal notranslate">'%'</code> character, which marks the start of the specifier.</li>

<li>Conversion flags (optional), which affect the result of some conversion

types.</li>

<li>Minimum field width (optional).

If specified as an <code class="docutils literal notranslate">'*'</code> (asterisk), the actual width is given in the

next argument, which must be of type int, and the object to

convert comes after the minimum field width and optional precision.</li>

<li>Precision (optional), given as a <code class="docutils literal notranslate">'.'</code> (dot) followed by the precision.

If specified as <code class="docutils literal notranslate">'*'</code> (an asterisk), the actual precision is given in

the next argument, which must be of type int, and the value to

convert comes after the precision.</li>

<li>Length modifier (optional).</li>

<li>Conversion type.</li>

</ol>

The conversion flag characters are:

<thead>

<th class="head">Meaning</th>

</tr>

</thead>

<tbody>

<td>The conversion will be zero padded for numeric values.</td>

</tr>

<td>The converted value is left adjusted (overrides the <code class="docutils literal notranslate">0</code>

flag if both are given).</td>

</tr>

</tbody>

</table>

The length modifiers for following integer conversions (<code class="docutils literal notranslate">d</code>, <code class="docutils literal notranslate">i</code>,

<code class="docutils literal notranslate">o</code>, <code class="docutils literal notranslate">u</code>, <code class="docutils literal notranslate">x</code>, or <code class="docutils literal notranslate">X</code>) specify the type of the argument

(int by default):

<thead>

<tr class="row-odd"><th class="head">Modifier</th>

<th class="head">Types</th>

</tr>

</thead>

<tbody>

<td>long or unsigned long</td>

</tr>

<td>long long or unsigned long long</td>

</tr>

<td><code class="xref c c-type docutils literal notranslate">intmax_t</code> or <code class="xref c c-type docutils literal notranslate">uintmax_t</code></td>

</tr>

<td><code class="xref c c-type docutils literal notranslate">size_t</code> or <code class="xref c c-type docutils literal notranslate">ssize_t</code></td>

</tr>

<td><code class="xref c c-type docutils literal notranslate">ptrdiff_t</code></td>

</tr>

</tbody>

</table>

The length modifier <code class="docutils literal notranslate">l</code> for following conversions <code class="docutils literal notranslate">s</code> or <code class="docutils literal notranslate">V</code> specify

that the type of the argument is const wchar_t*.

The conversion specifiers are:

<thead>

<tr class="row-odd"><th class="head">Conversion Specifier</th>

<th class="head">Comment</th>

</tr>

</thead>

<tbody>

<td>The literal <code class="docutils literal notranslate">%</code> character.</td>

</tr>