assertpy/assertpy/string.py at main · assertpy/assertpy · GitHub

History

413 lines (335 loc) · 15.6 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

# Redistribution and use in source and binary forms, with or without modification,

# are permitted provided that the following conditions are met:

# 1. Redistributions of source code must retain the above copyright notice, this

# list of conditions and the following disclaimer.

# 2. Redistributions in binary form must reproduce the above copyright notice,

# this list of conditions and the following disclaimer in the documentation

# and/or other materials provided with the distribution.

# 3. Neither the name of the copyright holder nor the names of its contributors

# may be used to endorse or promote products derived from this software without

# specific prior written permission.

# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND

# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED

# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR

# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES

# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;

# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON

# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT

# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS

# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

import sys

import re

import collections

if sys.version_info[0] == 3:

str_types = (str,)

unicode = str

Iterable = collections.abc.Iterable

else:

str_types = (basestring,)

unicode = unicode

Iterable = collections.Iterable

__tracebackhide__ = True

class StringMixin(object):

"""String assertions mixin."""

def is_equal_to_ignoring_case(self, other):

"""Asserts that val is a string and is case-insensitive equal to other.

Checks actual is equal to expected using the ``==`` operator and ``str.lower()``.

Args:

other: the expected value

Examples:

Usage::

assert_that('foo').is_equal_to_ignoring_case('FOO')

assert_that('FOO').is_equal_to_ignoring_case('foo')

assert_that('fOo').is_equal_to_ignoring_case('FoO')

Returns:

AssertionBuilder: returns this instance to chain to the next assertion

Raises:

AssertionError: if actual is **not** case-insensitive equal to expected

"""

if not isinstance(self.val, str_types):

raise TypeError('val is not a string')

if not isinstance(other, str_types):

raise TypeError('given arg must be a string')

if self.val.lower() != other.lower():

return self.error('Expected <%s> to be case-insensitive equal to <%s>, but was not.' % (self.val, other))

return self

def contains_ignoring_case(self, *items):

"""Asserts that val is string and contains the given item or items.

Walks val and checks for item or items using the ``==`` operator and ``str.lower()``.

Args:

*items: the item or items expected to be contained

Examples:

Usage::

assert_that('foo').contains_ignoring_case('F', 'oO')

assert_that(['a', 'B']).contains_ignoring_case('A', 'b')

assert_that({'a': 1, 'B': 2}).contains_ignoring_case('A', 'b')

assert_that({'a', 'B'}).contains_ignoring_case('A', 'b')

Returns:

AssertionBuilder: returns this instance to chain to the next assertion

Raises:

AssertionError: if val does **not** contain the case-insensitive item or items

"""

if len(items) == 0:

raise ValueError('one or more args must be given')

if isinstance(self.val, str_types):

if len(items) == 1:

if not isinstance(items[0], str_types):

raise TypeError('given arg must be a string')

if items[0].lower() not in self.val.lower():

return self.error('Expected <%s> to case-insensitive contain item <%s>, but did not.' % (self.val, items[0]))

else:

missing = []

for i in items:

if not isinstance(i, str_types):

raise TypeError('given args must all be strings')

if i.lower() not in self.val.lower():

missing.append(i)

if missing:

return self.error('Expected <%s> to case-insensitive contain items %s, but did not contain %s.' % (

self.val, self._fmt_items(items), self._fmt_items(missing)))

elif isinstance(self.val, Iterable):

missing = []

for i in items:

if not isinstance(i, str_types):

raise TypeError('given args must all be strings')

found = False

for v in self.val:

if not isinstance(v, str_types):

raise TypeError('val items must all be strings')

if i.lower() == v.lower():

found = True

break

if not found:

missing.append(i)

if missing:

return self.error('Expected <%s> to case-insensitive contain items %s, but did not contain %s.' % (

self.val, self._fmt_items(items), self._fmt_items(missing)))

else:

raise TypeError('val is not a string or iterable')

return self

def starts_with(self, prefix):

"""Asserts that val is string or iterable and starts with prefix.

Args:

prefix: the prefix

Examples:

Usage::

assert_that('foo').starts_with('fo')

assert_that(['a', 'b', 'c']).starts_with('a')

assert_that((1, 2, 3)).starts_with(1)

assert_that(((1, 2), (3, 4), (5, 6))).starts_with((1, 2))

Returns:

AssertionBuilder: returns this instance to chain to the next assertion

Raises:

AssertionError: if val does **not** start with prefix

"""

if prefix is None:

raise TypeError('given prefix arg must not be none')

if isinstance(self.val, str_types):

if not isinstance(prefix, str_types):

raise TypeError('given prefix arg must be a string')

if len(prefix) == 0:

raise ValueError('given prefix arg must not be empty')

if not self.val.startswith(prefix):

return self.error('Expected <%s> to start with <%s>, but did not.' % (self.val, prefix))

elif isinstance(self.val, Iterable):

if len(self.val) == 0:

raise ValueError('val must not be empty')

first = next(iter(self.val))

if first != prefix:

return self.error('Expected %s to start with <%s>, but did not.' % (self.val, prefix))

else:

raise TypeError('val is not a string or iterable')

return self

def ends_with(self, suffix):

"""Asserts that val is string or iterable and ends with suffix.

Args:

suffix: the suffix

Examples:

Usage::

assert_that('foo').ends_with('oo')

assert_that(['a', 'b', 'c']).ends_with('c')

assert_that((1, 2, 3)).ends_with(3)

assert_that(((1, 2), (3, 4), (5, 6))).ends_with((5, 6))

Returns:

AssertionBuilder: returns this instance to chain to the next assertion

Raises:

AssertionError: if val does **not** end with suffix

"""

if suffix is None:

raise TypeError('given suffix arg must not be none')

if isinstance(self.val, str_types):

if not isinstance(suffix, str_types):

raise TypeError('given suffix arg must be a string')

if len(suffix) == 0:

raise ValueError('given suffix arg must not be empty')

if not self.val.endswith(suffix):

return self.error('Expected <%s> to end with <%s>, but did not.' % (self.val, suffix))

elif isinstance(self.val, Iterable):

if len(self.val) == 0:

raise ValueError('val must not be empty')

last = None

for last in self.val:

pass

if last != suffix:

return self.error('Expected %s to end with <%s>, but did not.' % (self.val, suffix))

else:

raise TypeError('val is not a string or iterable')

return self

def matches(self, pattern):

"""Asserts that val is string and matches the given regex pattern.

Args:

pattern (str): the regular expression pattern, as raw string (aka prefixed with ``r``)

Examples:

Usage::

assert_that('foo').matches(r'\\w')

assert_that('123-456-7890').matches(r'\\d{3}-\\d{3}-\\d{4}')

Match is partial unless anchored, so these assertion pass::

assert_that('foo').matches(r'\\w')

assert_that('foo').matches(r'oo')

assert_that('foo').matches(r'\\w{2}')

To match the entire string, just use an anchored regex pattern where ``^`` and ``$``

match the start and end of line and ``\\A`` and ``\\Z`` match the start and end of string::

assert_that('foo').matches(r'^\\w{3}$')

assert_that('foo').matches(r'\\A\\w{3}\\Z')

And regex flags, such as ``re.MULTILINE`` and ``re.DOTALL``, can only be applied via

*inline modifiers*, such as ``(?m)`` and ``(?s)``::

s = '''bar

foo

baz'''

# using multiline (?m)

assert_that(s).matches(r'(?m)^foo$')

# using dotall (?s)

assert_that(s).matches(r'(?s)b(.*)z')

Returns:

AssertionBuilder: returns this instance to chain to the next assertion

Raises:

AssertionError: if val does **not** match pattern

Tip:

Regular expressions are tricky. Be sure to use raw strings (aka prefixed with ``r``).

Also, note that the :meth:`matches` assertion passes for partial matches (as does the

underlying ``re.match`` method). So, if you need to match the entire string, you must

include anchors in the regex pattern.

"""

if not isinstance(self.val, str_types):

raise TypeError('val is not a string')

if not isinstance(pattern, str_types):

raise TypeError('given pattern arg must be a string')

if len(pattern) == 0:

raise ValueError('given pattern arg must not be empty')

if re.search(pattern, self.val) is None:

return self.error('Expected <%s> to match pattern <%s>, but did not.' % (self.val, pattern))

return self

def does_not_match(self, pattern):

"""Asserts that val is string and does not match the given regex pattern.

Args:

pattern (str): the regular expression pattern, as raw string (aka prefixed with ``r``)

Examples:

Usage::

assert_that('foo').does_not_match(r'\\d+')

assert_that('123').does_not_match(r'\\w+')

Returns:

AssertionBuilder: returns this instance to chain to the next assertion

Raises:

AssertionError: if val **does** match pattern

assertpy/assertpy/string.py at main · assertpy/assertpy · GitHub

Uh oh!

Expand file tree

Breadcrumbs

string.py

Latest commit

History

Breadcrumbs

string.py

File metadata and controls